diff --git a/AGENTS.md b/AGENTS.md index 78007417..435758d3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,6 +2,10 @@ This guide tells AI agents how to keep bitvid aligned with the current product direction. Follow it whenever you touch code, content, or documentation inside this repository. +For any nostr related work, please review the nip documentation located in /docs/nips before begining work. + +**Comment publishing guardrail:** Session actors are limited to passive telemetry (e.g., view counters). Always require the logged-in Nostr signer when sending video comments through [`js/nostr/commentEvents.js`](js/nostr/commentEvents.js). See the reminder in [`docs/nostr-event-schemas.md`](docs/nostr-event-schemas.md#event-catalogue) for context. + --- ## 1. Release Channels: Main vs. Unstable diff --git a/README.md b/README.md index 3d08eafb..780acec2 100644 --- a/README.md +++ b/README.md @@ -132,8 +132,7 @@ package scripts to keep formatting, linting, and generated output consistent: ```bash npm run format # normalize CSS/HTML/JS/MD sources with Prettier + tailwindcss plugin npm run lint:css # enforce design token usage and guard against raw hex colors - npm run build:css # rebuild css/tailwind.generated.css from tailwind.source.css - npm run check:css # fail CI if tailwind.generated.css is out of date + npm run build # run the Tailwind build locally (output remains gitignored) ``` - **No hard-coded colors:** Follow the token-first rules in `AGENTS.md`—reach @@ -147,16 +146,15 @@ npm run format # format CSS/HTML/JS/MD with Prettier + tailwindcss pl npm run lint # run CSS, hex color, inline-style, design-token, and Tailwind color/bracket guards in one pass npm run lint:css # enforce token usage and forbid raw hex colors npm run lint:inline-styles # fail CI if inline style attributes or element.style usage slip in -npm run build:css # rebuild css/tailwind.generated.css from tailwind.source.css +npm run build # run the Tailwind build (delegates to npm run build:css) npm run build:beacon # bundle torrent/dist assets and re-run the inline-style guard npm run build:beacon:bundle # bundle beacon assets without running the guard (rarely needed) -npm run check:css # CI-friendly guard that fails if tailwind.generated.css is dirty ``` #### Admin runbook: regenerate Tailwind styles -Need to refresh `css/tailwind.generated.css` after token or template changes? -Run these commands from the repo root: +Need to confirm Tailwind picks up token or template changes? Run these +commands from the repo root: 1. Install dependencies (only required after cloning or when packages change): @@ -164,20 +162,16 @@ Run these commands from the repo root: npm install ``` -2. Rebuild the Tailwind bundle: +2. Rebuild the Tailwind bundle for local verification (the output stays + gitignored and CI/Netlify handle deploy-time generation): ```bash npm run build:css ``` -3. Optional: confirm the generated file is committed and up to date. - - ```bash - npm run check:css - ``` - -4. Commit the updated `css/tailwind.generated.css` alongside any HTML/JS edits - that rely on the new utilities so deploys pick up the refreshed styles. +The generated `css/tailwind.generated.css` artifact is ignored in git. CI +workflows and Netlify deploys run `npm run build` to produce the compiled +stylesheet during deployment, so source changes are all you need to commit. Inline styles are intentionally blocked. `npm run lint:inline-styles` scans HTML and scripts for `style=` attributes, `element.style`, or `style.cssText` usage @@ -218,11 +212,11 @@ calls over to the facades above so upgrades stay painless. The build command compiles Tailwind with `tailwind.config.cjs`, runs it through the PostCSS pipeline defined in `postcss.config.cjs` (for autoprefixing), and -emits the purged, minified stylesheet at `css/tailwind.generated.css`. Commit the -regenerated file alongside any template changes so deployments pick up the -latest styles. This generated bundle is the only stylesheet we ship—reference -`css/tailwind.generated.css` everywhere and avoid vendoring older `tailwind.min.css` -artifacts. +emits the purged, minified stylesheet at `css/tailwind.generated.css`. That +bundle is generated automatically during CI/Netlify deploys and remains +gitignored locally; reference `css/tailwind.generated.css` in templates, but do +not commit the compiled file. Avoid vendoring legacy `tailwind.min.css` +artifacts now that the deploy pipeline owns the build step. ### Logo usage @@ -327,8 +321,9 @@ placeholder at “—” and development builds log a warning—so mixed deploym ## Testing Continuous integration runs CSS linting/builds, the Playwright kitchen-sink snapshots, and the Node-based unit tests on every push. -Before pushing, run `npm run check:css` locally so `css/tailwind.generated.css` stays clean. Pair that with `npm run test:unit` for -application logic changes and `npm run test:visual` for presentation updates to mirror the CI surface area. +Before pushing, run `npm run build` locally so the Tailwind bundle regenerates. +Pair that with `npm run test:unit` for application logic changes and +`npm run test:visual` for presentation updates to mirror the CI surface area. ### Manual QA checklist diff --git a/components/edit-video-modal.html b/components/edit-video-modal.html index 52dc03b9..91cd83f0 100644 --- a/components/edit-video-modal.html +++ b/components/edit-video-modal.html @@ -146,12 +146,12 @@ type="number" id="editNip71Duration" min="0" - step="1" + step="0.001" data-nip71-input="duration" class="input" />

- Provide the runtime in whole seconds for timeline scrubbing. + Optional legacy fallback in seconds (fractions allowed) for clients that expect a top-level duration.

@@ -268,6 +268,34 @@ />

Optional magnet pointer if the variant is seeded via P2P.

+
+ + +

Fractional seconds supported; clients use this for precise timelines.

+
+
+ + +

Average bits per second for this variant.

+
diff --git a/components/sidebar.html b/components/sidebar.html index 46966c9b..a2aa5c9f 100644 --- a/components/sidebar.html +++ b/components/sidebar.html @@ -299,6 +299,28 @@ /> DNS + + + Tip Jar +
diff --git a/components/upload-modal.html b/components/upload-modal.html index b545855d..bd54e099 100644 --- a/components/upload-modal.html +++ b/components/upload-modal.html @@ -193,12 +193,13 @@ type="number" id="nip71Duration" min="0" - step="1" + step="0.001" data-nip71-input="duration" class="input" />

- Provide the runtime in whole seconds for timeline scrubbing. + Optional legacy fallback in seconds (fractions allowed) for clients that + expect a top-level duration.

@@ -412,22 +413,54 @@ HTTPS variant URL shared across clients.

-
- - -

- Optional magnet pointer if the variant is seeded via - P2P. -

-
+
+ + +

+ Optional magnet pointer if the variant is seeded via + P2P. +

+
+ + +

+ Fractional seconds supported; clients use this for precise timelines. +

+
+
+ + +

+ Average bits per second for this variant. +

+
+
diff --git a/components/video-modal.html b/components/video-modal.html index 64f7aa8b..0a77155b 100644 --- a/components/video-modal.html +++ b/components/video-modal.html @@ -157,12 +157,12 @@

diff --git a/config/instance-config.js b/config/instance-config.js index dfa246ec..93fe02f6 100644 --- a/config/instance-config.js +++ b/config/instance-config.js @@ -23,6 +23,15 @@ */ export const IS_DEV_MODE = true; +/** + * Whether development builds should surface extra verbose diagnostics. + * + * Set this to `true` to keep high-volume development warnings (like COUNT + * request failures) visible in the console. Flip it to `false` when you want + * a quieter dev mode without disabling other development helpers entirely. + */ +export const IS_VERBOSE_DEV_MODE = false; + /** * Whether the current deployment should operate in lockdown mode. * @@ -110,6 +119,17 @@ export const BETA_URL = "https://beta.bitvid.network/"; */ export const DNS_URL = "https://bitvid.network/"; +/** + * Optional external destination for the Tip Jar menu link. + * + * Configure this with the Lightning tipping experience you want to surface in + * the sidebar dropup. When left empty (null or an empty string) the Tip Jar + * entry is removed entirely so operators that do not collect donations are not + * forced to show the control. + */ +export const TIP_JAR_URL = + "https://nostrtipjar.netlify.app/?n=npub13yarr7j6vjqjjkahd63dmr27curypehx45ucue286ac7sft27y0srnpmpe"; + /** * Default image included in automated moderation DMs. * diff --git a/config/validate-config.js b/config/validate-config.js index f0edc3e0..83118535 100644 --- a/config/validate-config.js +++ b/config/validate-config.js @@ -14,6 +14,7 @@ import { GITHUB_URL, BETA_URL, DNS_URL, + TIP_JAR_URL, } from "./instance-config.js"; function assertSuperAdminConfigured(value) { @@ -123,6 +124,7 @@ function resolveConfig(overrides = {}) { githubUrl: overrides.GITHUB_URL ?? GITHUB_URL, betaUrl: overrides.BETA_URL ?? BETA_URL, dnsUrl: overrides.DNS_URL ?? DNS_URL, + tipJarUrl: overrides.TIP_JAR_URL ?? TIP_JAR_URL, }; } @@ -178,4 +180,5 @@ export function validateInstanceConfig(overrides) { assertOptionalHttpUrl(config.githubUrl, "GITHUB_URL"); assertOptionalHttpUrl(config.betaUrl, "BETA_URL"); assertOptionalHttpUrl(config.dnsUrl, "DNS_URL"); + assertOptionalHttpUrl(config.tipJarUrl, "TIP_JAR_URL"); } diff --git a/content/roadmap/04_bitvid_Enhanced_Profile_Channel_Views_Specification.md b/content/roadmap/04_bitvid_Enhanced_Profile_Channel_Views_Specification.md index 43faf7f2..5afc5887 100644 --- a/content/roadmap/04_bitvid_Enhanced_Profile_Channel_Views_Specification.md +++ b/content/roadmap/04_bitvid_Enhanced_Profile_Channel_Views_Specification.md @@ -100,7 +100,7 @@ Add placeholders for different views in `index.html`: - Fetch videos (`kind 30078`) filtered by the user's `npub`. ### **Subscriptions** -- Use `kind 30002` to manage the subscription list: +- Use `kind 30000` to manage the subscription follow set: - Subscribe: Add user to the list. - Unsubscribe: Remove user. diff --git a/content/roadmap/05_bitvid_Enhanced_Block_Subscription_&_Reporting_Specification.md b/content/roadmap/05_bitvid_Enhanced_Block_Subscription_&_Reporting_Specification.md index bd8e9f35..8b934b35 100644 --- a/content/roadmap/05_bitvid_Enhanced_Block_Subscription_&_Reporting_Specification.md +++ b/content/roadmap/05_bitvid_Enhanced_Block_Subscription_&_Reporting_Specification.md @@ -47,8 +47,8 @@ This document describes how to implement **Block Lists**, **Subscription Lists** A **Subscription List** lets users follow video creators independently of their main “following” list on Nostr. It supports categorization and can be made private via encryption. ### Event Kind -- **Kind**: `30002` -- **Description**: “Video Subscription List” (inspired by NIP-51 but for custom lists) +- **Kind**: `30000` +- **Description**: “Video Subscription Follow Set” aligned with [NIP-51 follow sets](../../docs/nips/51.md#sets) ### JSON Structure **Public Tags** @@ -64,7 +64,7 @@ A **Subscription List** lets users follow video creators independently of their ### Example ```json { - "kind": 30002, + "kind": 30000, "tags": [ ["d", "favorite-creators"], ["p", "npub1creator1pubkey"], @@ -208,7 +208,7 @@ The `p` tag references a pubkey, and the `e` tag references a note. The third el ## Implementation Details ### Replaceable Events -- **Subscription Lists** (`30002`) and **Block Lists** (`10001`) can be implemented as replaceable events by using a deterministic `d` tag. +- **Subscription Lists** (`30000`) and **Block Lists** (`10001`) can be implemented as replaceable events by using a deterministic `d` tag. - For example, `["d","my-blocklist"]` ensures older events with the same `d` are replaced when new ones arrive. ### Encryption @@ -220,7 +220,7 @@ The `p` tag references a pubkey, and the `e` tag references a note. The third el - Query each relay for events matching: ```jsonc { - "kinds": [10001, 30002], + "kinds": [10001, 30000], "authors": [] } ``` @@ -275,7 +275,7 @@ The `p` tag references a pubkey, and the `e` tag references a note. The third el ## Future Considerations 1. **Paid Subscriptions** - - Could layer subscription tiers on top of `30002` events. +- Could layer subscription tiers on top of `30000` events. 2. **Global Block Lists** - Let users publish or subscribe to a curated blocklist (or share one in a group). 3. **Web of Trust** @@ -284,4 +284,4 @@ The `p` tag references a pubkey, and the `e` tag references a note. The third el --- ### Summary -By leveraging Nostr event kinds (`30002` for subscriptions, `10001` for blocks, and `1984` for reports), bitvid can maintain a decentralized, user-controlled moderation system. Users can sync their lists across devices through relays, while administrators can choose how to handle flagged content on a platform level. This approach keeps moderation flexible and transparent. +By leveraging Nostr event kinds (`30000` for subscriptions, `10001` for blocks, and `1984` for reports), bitvid can maintain a decentralized, user-controlled moderation system. Users can sync their lists across devices through relays, while administrators can choose how to handle flagged content on a platform level. This approach keeps moderation flexible and transparent. diff --git a/content/roadmap/06_bitvid_Enhanced_Video_Comment_System_Specification.md b/content/roadmap/06_bitvid_Enhanced_Video_Comment_System_Specification.md index 0e6cd22f..a2c4a798 100644 --- a/content/roadmap/06_bitvid_Enhanced_Video_Comment_System_Specification.md +++ b/content/roadmap/06_bitvid_Enhanced_Video_Comment_System_Specification.md @@ -8,10 +8,10 @@ To implement a decentralized comment system for videos shared on a Nostr-based p ### **Features** 1. **Post Comments**: - Users can post comments on videos. - - Comments are associated with a specific video event using the `e` tag. + - Comments scope to the video definition or root event with NIP-22 uppercase tags (`A`/`E`/`I`, `K`, `P`) while still emitting lowercase fallbacks for legacy clients. 2. **Structured Threading**: - - Comments support threading by referencing parent comments using NIP-27 conventions. + - Comments support threading by referencing parent comments with the lowercase NIP-22 set (`a`/`e`/`i`, `k`, `p`). - Threaded replies are visually nested. 3. **Reactions**: @@ -40,18 +40,21 @@ To implement a decentralized comment system for videos shared on a Nostr-based p Each component (comments, reactions, live chat) is represented as a Nostr event. ##### **Comment Event**: -bitvid uses standard kind `1` text note replies so they interoperate with the moderation flows documented in [`docs/moderation/nips.md`](../../docs/moderation/nips.md). Each reply keeps both the video event ID and the root video definition tag so downstream services can resolve lineage. +bitvid publishes kind `1111` comments following [NIP-22](https://github.com/nostr-protocol/nips/blob/master/22.md). Each event declares its root scope with uppercase tags and keeps the lowercase fallbacks so legacy clients continue to render threads. ```json { - "kind": 1, + "kind": 1111, "pubkey": "abcdef1234567890...", "created_at": 1675000000, "tags": [ - ["e", "video-event-id"], // Reference to the specific video event - ["a", "30078:video-author-pubkey:video-root-id"], // Reference to the video definition (kind 30078) - ["e", "parent-comment-id"], // Optional: reference to the parent comment for replies - ["p", "commenter-pubkey"] // Optional: commenter or video author pubkey for threading UX + ["A", "30078:video-author-pubkey:video-root-id", "wss://video.example"], + ["K", "30078"], + ["P", "video-author-pubkey", "wss://video.example"], + ["a", "30078:video-author-pubkey:video-root-id", "wss://video.example"], + ["e", "parent-comment-id", "parent-author-pubkey"], + ["k", "1111"], + ["p", "parent-author-pubkey"] ], "content": "This is a great video!" } @@ -89,7 +92,7 @@ bitvid uses standard kind `1` text note replies so they interoperate with the mo Metadata tags are added to comments or live chat events as needed: ```json { - "kind": 1, + "kind": 1111, "pubkey": "abcdef1234567890...", "created_at": 1675000000, "tags": [ @@ -108,8 +111,8 @@ Metadata tags are added to comments or live chat events as needed: #### **1. Posting a Comment** To post a comment: -1. The client constructs a kind `1` comment event using NIP-22 for `created_at` validation. -2. The event includes both the `['e', ]` and `['a', <30078:pubkey:videoRootId>]` tags (mandatory) plus parent comment references when replying. This mirrors the implementation in `js/services/discussionCountService.js` so reply counts and moderation filters remain aligned. +1. The client constructs a kind `1111` comment event following NIP-22 threading semantics. +2. The event includes uppercase root scope tags (`['A'\|`E`\|`I`, ], `['K', ]`, `['P', ]`) and carries lowercase fallbacks (`['a', ...]`, `['e', ...]`, `['k', ...]`, `['p', ...]`) for older relays and clients. Parent references append `['e', , ?, ]`, `['k', ]`, and `['p', ]` when available. 3. The event is signed and published to relays. ##### API Example: @@ -120,13 +123,21 @@ async function postComment( parentCommentId = null ) { const event = { - kind: 1, + kind: 1111, pubkey: userPubkey, created_at: Math.floor(Date.now() / 1000), tags: [ - ['e', videoEventId], + ['A', `30078:${videoAuthorPubkey}:${videoRootId}`], + ['K', '30078'], + ['P', videoAuthorPubkey], ['a', `30078:${videoAuthorPubkey}:${videoRootId}`], - ...(parentCommentId ? [['e', parentCommentId]] : []), + ...(parentCommentId + ? [ + ['e', parentCommentId, videoAuthorPubkey], + ['k', '1111'], + ['p', videoAuthorPubkey], + ] + : [['k', '30078'], ['p', videoAuthorPubkey]]), ], content: commentText }; @@ -162,7 +173,7 @@ Comments are retrieved using `REQ` messages filtered by the `e` tag for the vide ```javascript async function fetchComments({ videoEventId, videoAuthorPubkey, videoRootId }) { const filter = { - kinds: [1], + kinds: [1111], '#e': [videoEventId], '#a': [`30078:${videoAuthorPubkey}:${videoRootId}`], limit: 100 diff --git a/content/roadmap/08_bitvid_Enhanced_Dynamic_Home_Page_&_Video_Tracking_Specification.md b/content/roadmap/08_bitvid_Enhanced_Dynamic_Home_Page_&_Video_Tracking_Specification.md index 62f6bd8d..fb4c1bf7 100644 --- a/content/roadmap/08_bitvid_Enhanced_Dynamic_Home_Page_&_Video_Tracking_Specification.md +++ b/content/roadmap/08_bitvid_Enhanced_Dynamic_Home_Page_&_Video_Tracking_Specification.md @@ -87,7 +87,7 @@ Rather than measuring active peers, bitvid now counts views by logging them as N - Compare the count of new views against a previous period, or calculate the rate of increase. 3. **For You** - - Look at what the user watched or subscribed to (via kind `30002` subscription lists). + - Look at what the user watched or subscribed to (via kind `30000` subscription follow sets). - Track the user’s or session’s recent view tags, then recommend videos with overlapping tags or from the same channels. --- @@ -124,7 +124,7 @@ Your `index.html` might include placeholders for each section: 1. **Fetch Data** - Pull video metadata from kind `30078` events that contain video info or from your existing approach. - - Pull subscription data (kind `30002`). + - Pull subscription data (kind `30000`). - Pull view events (kind `30078` with `"t", "view"`). 2. **Process Rankings** diff --git a/css/tailwind.source.css b/css/tailwind.source.css index 07c4042f..eb908430 100644 --- a/css/tailwind.source.css +++ b/css/tailwind.source.css @@ -863,12 +863,14 @@ } .moderation-badge__action:focus-visible { - outline: 2px solid color-mix(in srgb, var(--status-warning) 38%, transparent); - outline-offset: 2px; + outline: var(--outline-thick-width) + solid color-mix(in srgb, var(--status-warning) 38%, transparent); + outline-offset: var(--space-3xs); } .moderation-badge[data-variant="neutral"] .moderation-badge__action:focus-visible { - outline: 2px solid color-mix(in srgb, var(--status-neutral) 38%, transparent); + outline: var(--outline-thick-width) + solid color-mix(in srgb, var(--status-neutral) 38%, transparent); } .moderation-badge__action[disabled] { @@ -1625,6 +1627,23 @@ font-weight: 600; line-height: 1.3; color: var(--color-text); + min-width: 0; + overflow-wrap: break-word; + word-break: break-word; + } + + @media (min-width: theme("screens.lg")) { + .video-modal__headline #videoTitle.video-modal__title { + flex: 1 1 0%; + min-width: 0; + max-width: calc(100% - var(--space-3xl) - var(--space-md)); + } + + .video-modal__headline .video-modal__status { + flex: 0 0 auto; + max-width: clamp(var(--space-xl), 25%, var(--space-3xl)); + margin-left: auto; + } } #playerModal .modal-meta { @@ -2226,7 +2245,7 @@ padding-inline: var(--space-6xs); border-radius: var(--radius-full); font-family: var(--font-family-mono); - font-size: var(--font-size-2xs, 0.75rem); + font-size: var(--font-size-2xs); line-height: 1.2; color: var(--color-muted-strong); background-color: color-mix( @@ -2241,7 +2260,7 @@ align-items: center; flex-wrap: wrap; gap: clamp(var(--space-5xs), 0.5vw, var(--space-4xs)); - font-size: var(--font-size-2xs, 0.75rem); + font-size: var(--font-size-2xs); color: var(--color-muted-strong); min-width: 0; } @@ -2323,7 +2342,19 @@ @media (min-width: theme("screens.lg")) { .video-modal__video { position: sticky; - top: calc(var(--space-2xl) + var(--space-xl)); + top: calc(var(--space-2xl) + var(--space-3xl)); + z-index: 1; + } + + .video-modal__status { + flex-basis: clamp(var(--space-xl), 25%, var(--space-3xl)); + max-width: clamp(var(--space-xl), 25%, var(--space-3xl)); + } + + .video-modal__details { + position: relative; + z-index: 2; + margin-top: var(--space-lg); } } @@ -2354,9 +2385,7 @@ /* Video modal tag strip */ .video-modal__tags { - @apply -mx-1 flex gap-2 overflow-x-auto px-1; - scrollbar-gutter: stable both-edges; - overscroll-behavior-x: contain; + @apply -mx-1 flex gap-2 px-1; } .video-modal__similar .video-modal__tags { @@ -2400,6 +2429,14 @@ ); } + .video-tag-strip { + display: flex; + flex-wrap: nowrap; + align-items: center; + gap: var(--space-xs); + overflow: hidden; + } + .video-tag-pill { @apply inline-flex items-center gap-2 rounded-full border border-status-neutral-border bg-status-neutral-surface px-3 py-1 text-2xs font-medium text-status-neutral-on; @apply relative justify-center whitespace-nowrap transition; @@ -3669,7 +3706,7 @@ flex-direction: column; align-items: center; gap: var(--space-md); - padding: calc(var(--space-xl) + env(safe-area-inset-top, 0px)) + padding: calc(var(--space-xl) + env(safe-area-inset-top)) var(--space-lg) var(--space-lg); pointer-events: none; opacity: 0; diff --git a/docs/beacon/css-mapping.md b/docs/beacon/css-mapping.md index 28468562..995e6757 100644 --- a/docs/beacon/css-mapping.md +++ b/docs/beacon/css-mapping.md @@ -2,7 +2,7 @@ This inventory captures the selectors that mattered in `torrent/dist/beacon.vendor.css` and how they now map to design-system driven rules. The goal is to keep future tweaks aligned with shared tokens rather than re-introducing ad-hoc styles or vendor bundles. -> **Contributor note:** Beacon CSS updates must follow the [“Styling & Theming Rules (token-first)” guidance in `AGENTS.md`](../../AGENTS.md#styling--theming-rules-token-first) and the [README CSS build pipeline](../../README.md#css-build-pipeline). Run the relevant scripts before committing changes—at minimum `npm run lint:css`, `npm run build:css`, `npm run check:css`, and `npm run build:beacon` to ensure the Tailwind output and bundled assets stay in sync with token rules. +> **Contributor note:** Beacon CSS updates must follow the [“Styling & Theming Rules (token-first)” guidance in `AGENTS.md`](../../AGENTS.md#styling--theming-rules-token-first) and the [README CSS build pipeline](../../README.md#css-build-pipeline). Run the relevant scripts before committing changes—at minimum `npm run lint:css`, `npm run build`, and `npm run build:beacon` to ensure the Tailwind output and bundled assets stay in sync with token rules. ## Angular UI Grid diff --git a/docs/design-system.md b/docs/design-system.md index 8f6e44a7..e4ac598b 100644 --- a/docs/design-system.md +++ b/docs/design-system.md @@ -2,7 +2,7 @@ bitvid's visual language is now powered by Tailwind utilities backed by our design tokens. This document lists the primitives available via `css/tailwind.source.css`, how they behave across states, and when to mix them with Tailwind utilities. -All templates and embeds must load `css/tailwind.generated.css`; that compiled bundle is the only stylesheet shipped with the app. Remove any lingering references to legacy `tailwind.min.css` assets when porting surfaces into the design system. +All templates and embeds must load `css/tailwind.generated.css`; that compiled bundle is the only stylesheet shipped with the app. The file is generated during CI/Netlify deploys (and remains gitignored locally), so commit only the source styles that feed the build. Remove any lingering references to legacy `tailwind.min.css` assets when porting surfaces into the design system. > **UI Styling:** For day-to-day decisions, start with the [Styling & Theming Rules](../AGENTS.md#styling--theming-rules-token-first) in `AGENTS.md` and the [CSS build pipeline overview](../README.md#css-build-pipeline). Run `npm run lint:css` before committing so design-token regressions are caught early. diff --git a/docs/nips/01.md b/docs/nips/01.md new file mode 100644 index 00000000..1f564274 --- /dev/null +++ b/docs/nips/01.md @@ -0,0 +1,178 @@ +NIP-01 +====== + +Basic protocol flow description +------------------------------- + +`draft` `mandatory` + +This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. + +## Events and signatures + +Each user has a keypair. Signatures, public key, and encodings are done according to the [Schnorr signatures standard for the curve `secp256k1`](https://bips.xyz/340). + +The only object type that exists is the `event`, which has the following format on the wire: + +```yaml +{ + "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": , + "tags": [ + [...], + // ... + ], + "content": , + "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> +} +``` + +To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (which is described below) of the following structure: + +``` +[ + 0, + , + , + , + , + +] +``` + +To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: +- UTF-8 should be used for encoding. +- Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON. +- The following characters in the content field must be escaped as shown, and all other characters must be included verbatim: + - A line break (`0x0A`), use `\n` + - A double quote (`0x22`), use `\"` + - A backslash (`0x5C`), use `\\` + - A carriage return (`0x0D`), use `\r` + - A tab character (`0x09`), use `\t` + - A backspace, (`0x08`), use `\b` + - A form feed, (`0x0C`), use `\f` + +### Tags + +Each tag is an array of one or more strings, with some conventions around them. Take a look at the example below: + +```jsonc +{ + "tags": [ + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["alt", "reply"], + // ... + ], + // ... +} +``` + +The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. + +This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: + +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, , <32-bytes lowercase hex of the author's pubkey, optional>]` +- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` +- The `a` tag, used to refer to an addressable or replaceable event + - for an addressable event: `["a", ":<32-bytes lowercase hex of a pubkey>:", ]` + - for a normal replaceable event: `["a", ":<32-bytes lowercase hex of a pubkey>:", ]` (note: include the trailing colon) + +As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": ["5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"]}` filter. Only the first value in any given tag is indexed. + +### Kinds + +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, specifies the `kind:1` text note for social media applications. + +This NIP defines one basic kind: + +- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. + +And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: + +- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays. +- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. +- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. +- for kind `n` such that `30000 <= n < 40000`, events are **addressable** by their `kind`, `pubkey` and `d` tag value -- which means that, for each combination of `kind`, `pubkey` and the `d` tag value, only the latest event MUST be stored by relays, older versions MAY be discarded. + +In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. + +When answering to `REQ` messages for replaceable events such as `{"kinds":[0],"authors":[]}`, even if the relay has more than one version stored, it SHOULD return just the latest one. + +These are just conventions and relay implementations may differ. + +## Communication between clients and relays + +Relays expose a websocket endpoint to which clients can connect. Clients SHOULD open a single websocket connection to each relay and use it for all their subscriptions. Relays MAY limit number of connections from specific IP/client/etc. + +### From client to relay: sending events and creating subscriptions + +Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns: + + * `["EVENT", ]`, used to publish events. + * `["REQ", , , , ...]`, used to request events and subscribe to new updates. + * `["CLOSE", ]`, used to stop previous subscriptions. + +`` is an arbitrary, non-empty string of max length 64 chars. It represents a subscription per connection. Relays MUST manage ``s independently for each WebSocket connection. ``s are not guaranteed to be globally unique. + +`` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: + +```yaml +{ + "ids": , + "authors": , + "kinds": , + "#": , + "since": = to this to pass>, + "until": , + "limit": +} +``` + +Upon receiving a `REQ` message, the relay SHOULD return events that match the filter. Any new events it receives SHOULD be sent to that same websocket until the connection is closed, a `CLOSE` event is received with the same ``, or a new `REQ` is sent using the same `` (in which case a new subscription is created, replacing the old one). + +Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. + +The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values. + +The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. + +All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions. + +A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. + +The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. Newer events should appear first, and in the case of ties the event with the lowest id (first in lexical order) should be first. Relays SHOULD use the `limit` value to guide how many events are returned in the initial response. Returning fewer events is acceptable, but returning (much) more should be avoided to prevent overwhelming clients. + +### From relay to client: sending events and notices + +Relays can send 5 types of messages, which must also be JSON arrays, according to the following patterns: + + * `["EVENT", , ]`, used to send events requested by clients. + * `["OK", , , ]`, used to indicate acceptance or denial of an `EVENT` message. + * `["EOSE", ]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. + * `["CLOSED", , ]`, used to indicate that a subscription was ended on the server side. + * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. + +This NIP defines no rules for how `NOTICE` messages should be sent or treated. + +- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is `true`, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a `:` and then a human-readable message. Some examples: + * `["OK", "b1a649ebe8...", true, ""]` + * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` + * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]` + * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]` + * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]` + * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` + * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time"]` + * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` + * `["OK", "b1a649ebe8...", false, "restricted: not allowed to write."]` + * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` + * `["OK", "b1a649ebe8...", false, "mute: no one was listening to your ephemeral event and it wasn't handled in any way, it was ignored"]` +- `CLOSED` messages MUST be sent in response to a `REQ` when the relay refuses to fulfill it. It can also be sent when a relay decides to kill a subscription on its side before a client has disconnected or sent a `CLOSE`. This message uses the same pattern of `OK` messages with the machine-readable prefix and human-readable message. Some examples: + * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` + * `["CLOSED", "sub1", "error: could not connect to the database"]` + * `["CLOSED", "sub1", "error: shutting down idle subscription"]` +- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, `restricted`, `mute` and `error` for when none of that fits. diff --git a/docs/nips/02.md b/docs/nips/02.md new file mode 100644 index 00000000..8354bf0b --- /dev/null +++ b/docs/nips/02.md @@ -0,0 +1,78 @@ +NIP-02 +====== + +Follow List +----------- + +`final` `optional` + +A special event with kind `3`, meaning "follow list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. + +Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>,
, ]`. + +The `.content` is not used. + +For example: + +```jsonc +{ + "kind": 3, + "tags": [ + ["p", "91cf9..4e5ca", "wss://alicerelay.com/", "alice"], + ["p", "14aeb..8dad4", "wss://bobrelay.com/nostr", "bob"], + ["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"] + ], + "content": "", + // other fields... +} +``` + +Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one. + +Whenever new follows are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order. + +## Uses + +### Follow list backup + +If one believes a relay will store their events for sufficient time, they can use this kind-3 event to backup their following list and recover on a different device. + +### Profile discovery and context augmentation + +A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the follow lists of other people one might be following or browsing; or show the data in other contexts. + +### Relay sharing + +A client may publish a follow list with good relays for each of their follows so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance. + +### Petname scheme + +The data from these follow lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's follow lists. This alleviates the need for global human-readable names. For example: + +A user has an internal follow list that says + +```json +[ + ["p", "21df6d143fb96c2ec9d63726bf9edc71", "", "erin"] +] +``` + +And receives two follow lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says + +```json +[ + ["p", "a8bb3d884d5d90b413d9891fe4c4e46d", "", "david"] +] +``` + +and another from `a8bb3d884d5d90b413d9891fe4c4e46d` that says + +```json +[ + ["p", "f57f54057d2a7af0efecc8b0b66f5708", "", "frank"] +] +``` + +When the user sees `21df6d143fb96c2ec9d63726bf9edc71` the client can show _erin_ instead; +When the user sees `a8bb3d884d5d90b413d9891fe4c4e46d` the client can show _david.erin_ instead; +When the user sees `f57f54057d2a7af0efecc8b0b66f5708` the client can show _frank.david.erin_ instead. diff --git a/docs/nips/03.md b/docs/nips/03.md new file mode 100644 index 00000000..3cd40a07 --- /dev/null +++ b/docs/nips/03.md @@ -0,0 +1,34 @@ +NIP-03 +====== + +OpenTimestamps Attestations for Events +-------------------------------------- + +`draft` `optional` + +This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps](https://opentimestamps.org/) proof for any other event: + +```json +{ + "kind": 1040 + "tags": [ + ["e", , ], + ["k", ""] + ], + "content": +} +``` + +- The OpenTimestamps proof MUST prove the referenced `e` event id as its digest. +- The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation (as not more than one valid attestation is necessary and less bytes is better than more) and no reference to "pending" attestations since they are useless in this context. + +### Example OpenTimestamps proof verification flow + +Using [`nak`](https://github.com/fiatjaf/nak), [`jq`](https://jqlang.github.io/jq/) and [`ots`](https://github.com/fiatjaf/ots): + +```bash +~> nak req -i e71c6ea722987debdb60f81f9ea4f604b5ac0664120dd64fb9d23abc4ec7c323 wss://nostr-pub.wellorder.net | jq -r .content | ots verify +> using an esplora server at https://blockstream.info/api +- sequence ending on block 810391 is valid +timestamp validated at block [810391] +``` diff --git a/docs/nips/04.md b/docs/nips/04.md new file mode 100644 index 00000000..a561a2f8 --- /dev/null +++ b/docs/nips/04.md @@ -0,0 +1,55 @@ +> __Warning__ `unrecommended`: deprecated in favor of [NIP-17](17.md) + +NIP-04 +====== + +Encrypted Direct Message +------------------------ + +`final` `unrecommended` `optional` + +A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes: + +**`content`** MUST be equal to the base64-encoded, aes-256-cbc encrypted string of anything a user wants to write, encrypted using a shared cipher generated by combining the recipient's public-key with the sender's private-key; this appended by the base64-encoded initialization vector as if it was a querystring parameter named "iv". The format is the following: `"content": "?iv="`. + +**`tags`** MUST contain an entry identifying the receiver of the message (such that relays may naturally forward this event to them), in the form `["p", ""]`. + +**`tags`** MAY contain an entry identifying the previous message in a conversation or a message we are explicitly replying to (such that contextual, more organized conversations may happen), in the form `["e", ""]`. + +**Note**: By default in the [libsecp256k1](https://github.com/bitcoin-core/secp256k1) ECDH implementation, the secret is the SHA256 hash of the shared point (both X and Y coordinates). In Nostr, only the X coordinate of the shared point is used as the secret and it is NOT hashed. If using libsecp256k1, a custom function that copies the X coordinate must be passed as the `hashfp` argument in `secp256k1_ecdh`. See [here](https://github.com/bitcoin-core/secp256k1/blob/master/src/modules/ecdh/main_impl.h#L29). + +Code sample for generating such an event in JavaScript: + +```js +import crypto from 'crypto' +import * as secp from '@noble/secp256k1' + +let sharedPoint = secp.getSharedSecret(ourPrivateKey, '02' + theirPublicKey) +let sharedX = sharedPoint.slice(1, 33) + +let iv = crypto.randomFillSync(new Uint8Array(16)) +var cipher = crypto.createCipheriv( + 'aes-256-cbc', + Buffer.from(sharedX), + iv +) +let encryptedMessage = cipher.update(text, 'utf8', 'base64') +encryptedMessage += cipher.final('base64') +let ivBase64 = Buffer.from(iv.buffer).toString('base64') + +let event = { + pubkey: ourPubKey, + created_at: Math.floor(Date.now() / 1000), + kind: 4, + tags: [['p', theirPublicKey]], + content: encryptedMessage + '?iv=' + ivBase64 +} +``` + +## Security Warning + +This standard does not go anywhere near what is considered the state-of-the-art in encrypted communication between peers, and it leaks metadata in the events, therefore it must not be used for anything you really need to keep secret, and only with relays that use `AUTH` to restrict who can fetch your `kind:4` events. + +## Client Implementation Warning + +Clients *should not* search and replace public key or note references from the `.content`. If processed like a regular text note (where `@npub...` is replaced with `#[0]` with a `["p", "..."]` tag) the tags are leaked and the mentioned user will receive the message in their inbox. diff --git a/docs/nips/05.md b/docs/nips/05.md new file mode 100644 index 00000000..7e823fba --- /dev/null +++ b/docs/nips/05.md @@ -0,0 +1,103 @@ +NIP-05 +====== + +Mapping Nostr keys to DNS-based internet identifiers +---------------------------------------------------- + +`final` `optional` + +On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. + +Upon seeing that, the client splits the identifier into `` and `` and use these values to make a GET request to `https:///.well-known/nostr.json?name=`. + +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `user metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. + +### Example + +If a client sees an event like this: + +```jsonc +{ + "pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9", + "kind": 0, + "content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}" + // other fields... +} +``` + +It will make a GET request to `https://example.com/.well-known/nostr.json?name=bob` and get back a response that will look like + +```json +{ + "names": { + "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" + } +} +``` + +or with the **recommended** `"relays"` attribute: + +```json +{ + "names": { + "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" + }, + "relays": { + "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ] + } +} +``` + +If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed. + +The recommended `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays the specific user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available. + +## Finding users from their NIP-05 identifier + +A client may implement support for finding users' public keys from _internet identifiers_, the flow is the same as above, but reversed: first the client fetches the _well-known_ URL and from there it gets the public key of the user, then it tries to fetch the kind `0` event for that user and check if it has a matching `"nip05"`. + +## Notes + +### Identification, not verification + +The NIP-05 is not intended to _verify_ a user, but only to _identify_ them, for the purpose of facilitating the exchange of a contact or their search. +Exceptions are people who own (e.g., a company) or are connected (e.g., a project) to a well-known domain, who can exploit NIP-05 as an attestation of their relationship with it, and thus to the organization behind it, thereby gaining an element of trust. + +### User discovery implementation suggestion + +A client can use this to allow users to search other profiles. If a client has a search box or something like that, a user may be able to type "bob@example.com" there and the client would recognize that and do the proper queries to obtain a pubkey and suggest that to the user. + +### Clients must always follow public keys, not NIP-05 addresses + +For example, if after finding that `bob@bob.com` has the public key `abc...def`, the user clicks a button to follow that profile, the client must keep a primary reference to `abc...def`, not `bob@bob.com`. If, for any reason, the address `https://bob.com/.well-known/nostr.json?name=bob` starts returning the public key `1d2...e3f` at any time in the future, the client must not replace `abc...def` in his list of followed profiles for the user (but it should stop displaying "bob@bob.com" for that user, as that will have become an invalid `"nip05"` property). + +### Public keys must be in hex format + +Keys must be returned in hex format. Keys in NIP-19 `npub` format are only meant to be used for display in client UIs, not in this NIP. + +### Showing just the domain as an identifier + +Clients may treat the identifier `_@domain` as the "root" identifier, and choose to display it as just the ``. For example, if Bob owns `bob.com`, he may not want an identifier like `bob@bob.com` as that is redundant. Instead, Bob can use the identifier `_@bob.com` and expect Nostr clients to show and treat that as just `bob.com` for all purposes. + +### Reasoning for the `/.well-known/nostr.json?name=` format + +By adding the `` as a query string instead of as part of the path, the protocol can support both dynamic servers that can generate JSON on-demand and static servers with a JSON file in it that may contain multiple names. + +### Allowing access from JavaScript apps + +JavaScript Nostr apps may be restricted by browser [CORS][] policies that prevent them from accessing `/.well-known/nostr.json` on the user's domain. When CORS prevents JS from loading a resource, the JS program sees it as a network failure identical to the resource not existing, so it is not possible for a pure-JS app to tell the user for certain that the failure was caused by a CORS issue. JS Nostr apps that see network failures requesting `/.well-known/nostr.json` files may want to recommend to users that they check the CORS policy of their servers, e.g.: + +```bash +$ curl -sI https://example.com/.well-known/nostr.json?name=bob | grep -i ^Access-Control +Access-Control-Allow-Origin: * +``` + +Users should ensure that their `/.well-known/nostr.json` is served with the HTTP header `Access-Control-Allow-Origin: *` to ensure it can be validated by pure JS apps running in modern browsers. + +[CORS]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS + +### Security Constraints + +The `/.well-known/nostr.json` endpoint MUST NOT return any HTTP redirects. + +Fetchers MUST ignore any HTTP redirects given by the `/.well-known/nostr.json` endpoint. diff --git a/docs/nips/06.md b/docs/nips/06.md new file mode 100644 index 00000000..0e502543 --- /dev/null +++ b/docs/nips/06.md @@ -0,0 +1,31 @@ +NIP-06 +====== + +Basic key derivation from mnemonic seed phrase +---------------------------------------------- + +`draft` `optional` + +[BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them. + +[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/'/0/0` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)). + +A basic client can simply use an `account` of `0` to derive a single key. For more advanced use-cases you can increment `account`, allowing generation of practically infinite keys from the 5-level path with hardened derivation. + +Other types of clients can still get fancy and use other derivation paths for their own other purposes. + +### Test vectors + +mnemonic: leader monkey parrot ring guide accident before fence cannon height naive bean\ +private key (hex): 7f7ff03d123792d6ac594bfa67bf6d0c0ab55b6b1fdb6249303fe861f1ccba9a\ +nsec: nsec10allq0gjx7fddtzef0ax00mdps9t2kmtrldkyjfs8l5xruwvh2dq0lhhkp\ +public key (hex): 17162c921dc4d2518f9a101db33695df1afb56ab82f5ff3e5da6eec3ca5cd917\ +npub: npub1zutzeysacnf9rru6zqwmxd54mud0k44tst6l70ja5mhv8jjumytsd2x7nu + +--- + +mnemonic: what bleak badge arrange retreat wolf trade produce cricket blur garlic valid proud rude strong choose busy staff weather area salt hollow arm fade\ +private key (hex): c15d739894c81a2fcfd3a2df85a0d2c0dbc47a280d092799f144d73d7ae78add\ +nsec: nsec1c9wh8xy5eqdzln7n5t0ctgxjcrdug73gp5yj0x03gntn67h83twssdfhel\ +public key (hex): d41b22899549e1f3d335a31002cfd382174006e166d3e658e3a5eecdb6463573\ +npub: npub16sdj9zv4f8sl85e45vgq9n7nsgt5qphpvmf7vk8r5hhvmdjxx4es8rq74h diff --git a/docs/nips/07.md b/docs/nips/07.md new file mode 100644 index 00000000..294acd38 --- /dev/null +++ b/docs/nips/07.md @@ -0,0 +1,32 @@ +NIP-07 +====== + +`window.nostr` capability for web browsers +------------------------------------------ + +`draft` `optional` + +The `window.nostr` object may be made available by web browsers or extensions and websites or web-apps may make use of it after checking its availability. + +That object must define the following methods: + +``` +async window.nostr.getPublicKey(): string // returns a public key as hex +async window.nostr.signEvent(event: { created_at: number, kind: number, tags: string[][], content: string }): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it +``` + +Aside from these two basic above, the following functions can also be implemented optionally: +``` +async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated) +async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated) +async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertext as specified in nip-44 +async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44 +``` + +### Recommendation to Extension Authors +To make sure that the `window.nostr` is available to nostr clients on page load, the authors who create Chromium and Firefox extensions should load their scripts by specifying `"run_at": "document_end"` in the extension's manifest. + + +### Implementation + +See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions. diff --git a/docs/nips/08.md b/docs/nips/08.md new file mode 100644 index 00000000..f4f4341d --- /dev/null +++ b/docs/nips/08.md @@ -0,0 +1,21 @@ +> __Warning__ `unrecommended`: deprecated in favor of [NIP-27](27.md) + +NIP-08 +====== + +Handling Mentions +----------------- + +`final` `unrecommended` `optional` + +This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. + +Clients that want to allow tagged mentions they MUST show an autocomplete component or something analogous to that whenever the user starts typing a special key (for example, "@") or presses some button to include a mention etc -- or these clients can come up with other ways to unambiguously differentiate between mentions and normal text. + +Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867eefdfa9580434bc3e675be08d2acb526610d96fbe`, the client MUST add that pubkey to the `.tags` with the tag `p`, then replace its textual reference (inside `.content`) with the notation `#[index]` in which "index" is equal to the 0-based index of the related tag in the tags array. + +The same process applies for mentioning event IDs. + +A client that receives a `text_note` event with such `#[index]` mentions in its `.content` CAN do a search-and-replace using the actual contents from the `.tags` array with the actual pubkey or event ID that is mentioned, doing any desired context augmentation (for example, linking to the pubkey or showing a preview of the mentioned event contents) it wants in the process. + +Where `#[index]` has an `index` that is outside the range of the tags array or points to a tag that is not an `e` or `p` tag or a tag otherwise declared to support this notation, the client MUST NOT perform such replacement or augmentation, but instead display it as normal text. diff --git a/docs/nips/09.md b/docs/nips/09.md new file mode 100644 index 00000000..23ffeab1 --- /dev/null +++ b/docs/nips/09.md @@ -0,0 +1,53 @@ +NIP-09 +====== + +Event Deletion Request +---------------------- + +`draft` `optional` + +A special event with kind `5`, meaning "deletion request" is defined as having a list of one or more `e` or `a` tags, each referencing an event the author is requesting to be deleted. Deletion requests SHOULD include a `k` tag for the kind of each event being requested for deletion. + +The event's `content` field MAY contain a text note describing the reason for the deletion request. + +For example: + +```jsonc +{ + "kind": 5, + "pubkey": <32-bytes hex-encoded public key of the event creator>, + "tags": [ + ["e", "dcd59..464a2"], + ["e", "968c5..ad7a4"], + ["a", "::"], + ["k", "1"], + ["k", "30023"] + ], + "content": "these posts were published by accident", + // other fields... +} +``` + +Relays SHOULD delete or stop publishing any referenced events that have an identical `pubkey` as the deletion request. Clients SHOULD hide or otherwise indicate a deletion request status for referenced events. + +Relays SHOULD continue to publish/share the deletion request events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion request events to other relays which don't have it. + +When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion request event. + +## Client Usage + +Clients MAY choose to fully hide any events that are referenced by valid deletion request events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion request reason, not the original content. + +A client MUST validate that each event `pubkey` referenced in the `e` tag of the deletion request is identical to the deletion request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative. + +Clients display the deletion request event itself in any way they choose, e.g., not at all, or with a prominent notice. + +Clients MAY choose to inform the user that their request for deletion does not guarantee deletion because it is impossible to delete events from all relays and clients. + +## Relay Usage + +Relays MAY validate that a deletion request event only references events that have the same `pubkey` as the deletion request itself, however this is not required since relays may not have knowledge of all referenced events. + +## Deletion Request of a Deletion Request + +Publishing a deletion request event against a deletion request has no effect. Clients and relays are not obliged to support "unrequest deletion" functionality. diff --git a/docs/nips/10.md b/docs/nips/10.md new file mode 100644 index 00000000..9fd4415e --- /dev/null +++ b/docs/nips/10.md @@ -0,0 +1,84 @@ +NIP-10 +====== + +Text Notes and Threads +---------------------- + +`draft` `optional` + +This NIP defines `kind:1` as a simple plaintext note. + +## Abstract + +The `.content` property contains some human-readable text. + +`e` tags can be used to define note thread roots and replies. They SHOULD be sorted by the reply stack from root to the direct parent. + +`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). + +```json +["q", " or ", "", ""] +``` + +Authors of the `e` and `q` tags SHOULD be added as `p` tags to notify of a new reply or quote. + +Markup languages such as markdown and HTML SHOULD NOT be used. + +## Marked "e" tags (PREFERRED) + +Kind 1 events with `e` tags are replies to other kind 1 events. Kind 1 replies MUST NOT be used to reply to other kinds, use [NIP-22](22.md) instead. + +`["e", , , , ]` + +Where: + + * `` is the id of the event being referenced. + * `` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `` field, but may instead leave it as `""`. + * `` is optional and if present is one of `"reply"`, `"root"`. + * `` is optional, SHOULD be the pubkey of the author of the referenced event + +Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. + +A direct reply to the root of a thread should have a single marked "e" tag of type "root". + +>This scheme is preferred because it allows events to mention others without confusing them with `` or ``. + +`` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event. + +## The "p" tag +Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. + +When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. + +Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] +in no particular order. + +## Deprecated Positional "e" tags + +This scheme is not in common use anymore and is here just to keep backward compatibility with older events on the network. + +Positional `e` tags are deprecated because they create ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. + +They use simple `e` tags without any marker. + +`["e", , ]` as per NIP-01. + +Where: + + * `` is the id of the event being referenced. + * `` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. + +**The positions of the "e" tags within the event denote specific meanings as follows**: + + * No "e" tag:
+ This event is not a reply to, nor does it refer to, any other event. + + * One "e" tag:
+ `["e", ]`: The id of the event to which this event is a reply. + + * Two "e" tags: `["e", ]`, `["e", ]`
+ `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. + + * Many "e" tags: `["e", ]` `["e", ]`, ..., `["e", ]`
+There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. +They are citing from this event. `root-id` and `reply-id` are as above. \ No newline at end of file diff --git a/docs/nips/11.md b/docs/nips/11.md new file mode 100644 index 00000000..5c3b9dab --- /dev/null +++ b/docs/nips/11.md @@ -0,0 +1,367 @@ +NIP-11 +====== + +Relay Information Document +-------------------------- + +`draft` `optional` + +Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. + +When a relay receives an HTTP(s) request with an `Accept` header of `application/nostr+json` to a URI supporting WebSocket upgrades, they SHOULD return a document with the following structure. + +```json +{ + "name": , + "description": , + "banner": , + "icon": , + "pubkey": , + "contact": , + "supported_nips": , + "software": , + "version": , + "privacy_policy": , + "terms_of_service": , +} +``` + +Any field may be omitted, and clients MUST ignore any additional fields they do not understand. Relays MUST accept CORS requests by sending `Access-Control-Allow-Origin`, `Access-Control-Allow-Headers`, and `Access-Control-Allow-Methods` headers. + +Field Descriptions +------------------ + +### Name + +A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation. + +### Description + +Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. + +### Banner + +To make nostr relay management more user friendly, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay, complementing the text `Description`. [Here is an example banner](https://image.nostr.build/232ddf6846e8aea5a61abcd70f9222ab521f711aa545b7ab02e430248fa3a249.png) mockup as visualized in Damus iOS relay view of the Damus relay. + +### Icon + +Icon is a compact visual representation of the relay for use in UI with limited real estate such as a nostr user's relay list view. Below is an example URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. + +```jsonc +{ + "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", + // other fields... +} +``` + +### Pubkey + +An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. + +Relay operators have no obligation to respond to direct messages. + +### Contact + +An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact. + +### Supported NIPs + +As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients. + +### Software + +The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage. + +### Version + +The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. + +### Privacy Policy + +The relay owner/admin MAY choose to link to a privacy policy document, which describes how the relay utilizes user data. Data collection, data usage, data retention, monetization of data, and third party data sharing SHOULD be included. + +### Terms of Service + +The relay owner/admin MAY choose to link to a terms of service document. + + + +Extra Fields +------------ + +### Server Limitations + +These are limitations imposed by the relay on clients. Your client +should expect that requests exceed these *practical* limitations +are rejected or fail immediately. + +```jsonc +{ + "limitation": { + "max_message_length": 16384, + "max_subscriptions": 300, + "max_limit": 5000, + "max_subid_length": 100, + "max_event_tags": 100, + "max_content_length": 8196, + "min_pow_difficulty": 30, + "auth_required": true, + "payment_required": true, + "restricted_writes": true, + "created_at_lower_limit": 31536000, + "created_at_upper_limit": 3, + "default_limit": 500 + }, + // other fields... +} +``` + +- `max_message_length`: the maximum number of bytes for incoming JSON that the relay +will attempt to decode and act upon. When you send large subscriptions, you will be +limited by this value. It also effectively limits the maximum size of any event. Value is +calculated from `[` to `]` after UTF-8 serialization (so some unicode characters +will cost 2-3 bytes). It is equal to the maximum size of the WebSocket message frame. + +- `max_subscriptions`: total number of subscriptions that may be +active on a single websocket connection to this relay. Authenticated clients with a (paid) relationship to the relay +may have higher limits. + +- `max_subid_length`: maximum length of subscription id as a string. + +- `max_limit`: the relay server will clamp each filter's `limit` value to this number. +This means the client won't be able to get more than this number +of events from a single subscription filter. This clamping is typically done silently +by the relay, but with this number, you can know that there are additional results +if you narrow your filter's time range or other parameters. + +- `max_event_tags`: in any event, this is the maximum number of elements in the `tags` list. + +- `max_content_length`: maximum number of characters in the `content` +field of any event. This is a count of unicode characters. After +serializing into JSON it may be larger (in bytes), and is still +subject to the `max_message_length`, if defined. + +- `min_pow_difficulty`: new events will require at least this difficulty of PoW, +based on [NIP-13](13.md), or they will be rejected by this server. + +- `auth_required`: this relay requires [NIP-42](42.md) authentication +to happen before a new connection may perform any other action. +Even if set to False, authentication may be required for specific actions. + +- `payment_required`: this relay requires payment before a new connection may perform any action. + +- `restricted_writes`: this relay requires some kind of condition to be fulfilled to +accept events (not necessarily, but including `payment_required` and `min_pow_difficulty`). +This should only be set to `true` when users are expected to know the relay policy before trying +to write to it -- like belonging to a special pubkey-based whitelist or writing only events of +a specific niche kind or content. Normal anti-spam heuristics, for example, do not qualify. + +- `created_at_lower_limit`: 'created_at' lower limit + +- `created_at_upper_limit`: 'created_at' upper limit + +- `default_limit`: The maximum returned events if you send a filter without a `limit`. + +### Event Retention + +There may be a cost associated with storing data forever, so relays +may wish to state retention times. The values stated here are defaults +for unauthenticated users and visitors. Paid users would likely have +other policies. + +Retention times are given in seconds, with `null` indicating infinity. +If zero is provided, this means the event will not be stored at +all, and preferably an error will be provided when those are received. + +```jsonc +{ + "retention": [ + {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600}, + {"kinds": [[40000, 49999]], "time": 100}, + {"kinds": [[30000, 39999]], "count": 1000}, + {"time": 3600, "count": 10000} + ], + // other fields... +} +``` + +`retention` is a list of specifications: each will apply to either all kinds, or +a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive +start and end values. Events of indicated kind (or all) are then limited to a `count` +and/or time period. + +It is possible to effectively blacklist Nostr-based protocols that rely on +a specific `kind` number, by giving a retention time of zero for those `kind` values. +While that is unfortunate, it does allow clients to discover servers that will +support their protocol quickly via a single HTTP fetch. + +There is no need to specify retention times for _ephemeral events_ since they are not retained. + +### Content Limitations + +Some relays may be governed by the arbitrary laws of a nation state. This +may limit what content can be stored in clear-text on those relays. All +clients are encouraged to use encryption to work around this limitation. + +It is not possible to describe the limitations of each country's laws +and policies which themselves are typically vague and constantly shifting. + +Therefore, this field allows the relay operator to indicate which +countries' laws might end up being enforced on them, and then +indirectly on their users' content. + +Users should be able to avoid relays in countries they don't like, +and/or select relays in more favorable zones. Exposing this +flexibility is up to the client software. + +```jsonc +{ + "relay_countries": [ "CA", "US" ], + // other fields... +} +``` + +- `relay_countries`: a list of two-level ISO country codes (ISO 3166-1 alpha-2) whose + laws and policies may affect this relay. `EU` may be used for European Union countries. A `*` can be used for global relays. + +Remember that a relay may be hosted in a country which is not the +country of the legal entities who own the relay, so it's very +likely a number of countries are involved. + + +### Community Preferences + +For public text notes at least, a relay may try to foster a +local community. This would encourage users to follow the global +feed on that relay, in addition to their usual individual follows. +To support this goal, relays MAY specify some of the following values. + +```jsonc +{ + "language_tags": ["en", "en-419"], + "tags": ["sfw-only", "bitcoin-only", "anime"], + "posting_policy": "https://example.com/posting-policy.html", + // other fields... +} +``` + +- `language_tags` is an ordered list + of [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) indicating + the major languages spoken on the relay. A `*` can be used for global relays. + +- `tags` is a list of limitations on the topics to be discussed. + For example `sfw-only` indicates that only "Safe For Work" content + is encouraged on this relay. This relies on assumptions of what the + "work" "community" feels "safe" talking about. In time, a common + set of tags may emerge that allow users to find relays that suit + their needs, and client software will be able to parse these tags easily. + The `bitcoin-only` tag indicates that any *altcoin*, *"crypto"* or *blockchain* + comments will be ridiculed without mercy. + +- `posting_policy` is a link to a human-readable page which specifies the + community policies for the relay. In cases where `sfw-only` is True, it's + important to link to a page which gets into the specifics of your posting policy. + +The `description` field should be used to describe your community +goals and values, in brief. The `posting_policy` is for additional +detail and legal terms. Use the `tags` field to signify limitations +on content, or topics to be discussed, which could be machine +processed by appropriate client software. + +### Pay-to-Relay + +Relays that require payments may want to expose their fee schedules. + +```jsonc +{ + "payments_url": "https://my-relay/payments", + "fees": { + "admission": [{ "amount": 1000000, "unit": "msats" }], + "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], + "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], + }, + // other fields... +} +``` + +### Examples + +As of 25 March 2025 the following command provided these results: + +```bash +curl -H "Accept: application/nostr+json" https://jellyfish.land | jq +``` + +```json +{ + "name": "JellyFish", + "description": "Stay Immortal!", + "banner": "https://image.nostr.build/7fdefea2dec1f1ec25b8ce69362566c13b2b7f13f1726c2e4584f05f64f62496.jpg", + "pubkey": "bf2bee5281149c7c350f5d12ae32f514c7864ff10805182f4178538c2c421007", + "contact": "hi@dezh.tech", + "software": "https://github.com/dezh-tech/immortal", + "supported_nips": [ + 1, + 9, + 11, + 13, + 17, + 40, + 42, + 59, + 62, + 70 + ], + "version": "immortal - 0.0.9", + "relay_countries": [ + "*" + ], + "language_tags": [ + "*" + ], + "tags": [], + "posting_policy": "https://jellyfish.land/tos.txt", + "payments_url": "https://jellyfish.land/relay", + "icon": "https://image.nostr.build/2547e9ec4b23589e09bc7071e0806c3d4293f76284c58ff331a64bce978aaee8.jpg", + "retention": [], + "fees": { + "subscription": [ + { + "amount": 3000, + "period": 2628003, + "unit": "sats" + }, + { + "amount": 8000, + "period": 7884009, + "unit": "sats" + }, + { + "amount": 15000, + "period": 15768018, + "unit": "sats" + }, + { + "amount": 28000, + "period": 31536036, + "unit": "sats" + } + ] + }, + "limitation": { + "auth_required": false, + "max_message_length": 70000, + "max_subid_length": 256, + "max_subscriptions": 350, + "min_pow_difficulty": 0, + "payment_required": true, + "restricted_writes": true, + "max_event_tags": 2000, + "max_content_length": 70000, + "created_at_lower_limit": 0, + "created_at_upper_limit": 2147483647, + "default_limit": 500, + "max_limit": 5000 + } +} +``` diff --git a/docs/nips/12.md b/docs/nips/12.md new file mode 100644 index 00000000..bf0eda9e --- /dev/null +++ b/docs/nips/12.md @@ -0,0 +1,9 @@ +NIP-12 +====== + +Generic Tag Queries +------------------- + +`final` `mandatory` + +Moved to [NIP-01](01.md). diff --git a/docs/nips/13.md b/docs/nips/13.md new file mode 100644 index 00000000..cf5b1acd --- /dev/null +++ b/docs/nips/13.md @@ -0,0 +1,102 @@ +NIP-13 +====== + +Proof of Work +------------- + +`draft` `optional` + +This NIP defines a way to generate and interpret Proof of Work for nostr notes. Proof of Work (PoW) is a way to add a proof of computational work to a note. This is a bearer proof that all relays and clients can universally validate with a small amount of code. This proof can be used as a means of spam deterrence. + +`difficulty` is defined to be the number of leading zero bits in the `NIP-01` id. For example, an id of `000000000e9d97a1ab09fc381030b346cdd7a142ad57e6df0b46dc9bef6c7e2d` has a difficulty of `36` with `36` leading 0 bits. + +`002f...` is `0000 0000 0010 1111...` in binary, which has 10 leading zeroes. Do not forget to count leading zeroes for hex digits <= `7`. + +Mining +------ + +To generate PoW for a `NIP-01` note, a `nonce` tag is used: + +```json +{"content": "It's just me mining my own business", "tags": [["nonce", "1", "21"]]} +``` + +When mining, the second entry to the nonce tag is updated, and then the id is recalculated (see [NIP-01](./01.md)). If the id has the desired number of leading zero bits, the note has been mined. It is recommended to update the `created_at` as well during this process. + +The third entry to the nonce tag `SHOULD` contain the target difficulty. This allows clients to protect against situations where bulk spammers targeting a lower difficulty get lucky and match a higher difficulty. For example, if you require 40 bits to reply to your thread and see a committed target of 30, you can safely reject it even if the note has 40 bits difficulty. Without a committed target difficulty you could not reject it. Committing to a target difficulty is something all honest miners should be ok with, and clients `MAY` reject a note matching a target difficulty if it is missing a difficulty commitment. + +Example mined note +------------------ + +```json +{ + "id": "000006d8c378af1779d2feebc7603a125d99eca0ccf1085959b307f64e5dd358", + "pubkey": "a48380f4cfcc1ad5378294fcac36439770f9c878dd880ffa94bb74ea54a6f243", + "created_at": 1651794653, + "kind": 1, + "tags": [ + ["nonce", "776797", "20"] + ], + "content": "It's just me mining my own business", + "sig": "284622fc0a3f4f1303455d5175f7ba962a3300d136085b9566801bc2e0699de0c7e31e44c81fb40ad9049173742e904713c3594a1da0fc5d2382a25c11aba977" +} +``` + +Validating +---------- + +Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id: + +```c +int zero_bits(unsigned char b) +{ + int n = 0; + + if (b == 0) + return 8; + + while (b >>= 1) + n++; + + return 7-n; +} + +/* find the number of leading zero bits in a hash */ +int count_leading_zero_bits(unsigned char *hash) +{ + int bits, total, i; + for (i = 0, total = 0; i < 32; i++) { + bits = zero_bits(hash[i]); + total += bits; + if (bits != 8) + break; + } + return total; +} +``` + +Here is some JavaScript code for doing the same thing: + +```javascript +// hex should be a hexadecimal string (with no 0x prefix) +function countLeadingZeroes(hex) { + let count = 0; + + for (let i = 0; i < hex.length; i++) { + const nibble = parseInt(hex[i], 16); + if (nibble === 0) { + count += 4; + } else { + count += Math.clz32(nibble) - 28; + break; + } + } + + return count; +} +``` + +Delegated Proof of Work +----------------------- + +Since the `NIP-01` note id does not commit to any signature, PoW can be outsourced to PoW providers, perhaps for a fee. This provides a way for clients to get their messages out to PoW-restricted relays without having to do any work themselves, which is useful for energy-constrained devices like mobile phones. diff --git a/docs/nips/14.md b/docs/nips/14.md new file mode 100644 index 00000000..480c4c57 --- /dev/null +++ b/docs/nips/14.md @@ -0,0 +1,21 @@ +NIP-14 +====== + +Subject tag in Text events +-------------------------- + +`draft` `optional` + +This NIP defines the use of the "subject" tag in text (kind: 1) events. +(implemented in more-speech) + +```json +["subject": ] +``` + +Browsers often display threaded lists of messages. The contents of the subject tag can be used in such lists, instead of the more ad hoc approach of using the first few words of the message. This is very similar to the way email browsers display lists of incoming emails by subject rather than by contents. + +When replying to a message with a subject, clients SHOULD replicate the subject tag. Clients MAY adorn the subject to denote +that it is a reply. e.g. by prepending "Re:". + +Subjects should generally be shorter than 80 chars. Long subjects will likely be trimmed by clients. diff --git a/docs/nips/15.md b/docs/nips/15.md new file mode 100644 index 00000000..b55b4448 --- /dev/null +++ b/docs/nips/15.md @@ -0,0 +1,339 @@ +NIP-15 +====== + +Nostr Marketplace +----------------- + +`draft` `optional` + +Based on [Diagon-Alley](https://github.com/lnbits/Diagon-Alley). + +Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). + +## Terms + +- `merchant` - seller of products with NOSTR key-pair +- `customer` - buyer of products with NOSTR key-pair +- `product` - item for sale by the `merchant` +- `stall` - list of products controlled by `merchant` (a `merchant` can have multiple stalls) +- `marketplace` - clientside software for searching `stalls` and purchasing `products` + +## Nostr Marketplace Clients + +### Merchant admin + +Where the `merchant` creates, updates and deletes `stalls` and `products`, as well as where they manage sales, payments and communication with `customers`. + +The `merchant` admin software can be purely clientside, but for `convenience` and uptime, implementations will likely have a server client listening for NOSTR events. + +### Marketplace + +`Marketplace` software should be entirely clientside, either as a stand-alone app, or as a purely frontend webpage. A `customer` subscribes to different merchant NOSTR public keys, and those `merchants` `stalls` and `products` become listed and searchable. The marketplace client is like any other ecommerce site, with basket and checkout. `Marketplaces` may also wish to include a `customer` support area for direct message communication with `merchants`. + +## `Merchant` publishing/updating products (event) + +A merchant can publish these events: +| Kind | | Description | +| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | +| `0` | `set_meta` | The merchant description (similar with any `nostr` public key). | +| `30017` | `set_stall` | Create or update a stall. | +| `30018` | `set_product` | Create or update a product. | +| `4` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | +| `5` | `delete` | Delete a product or a stall. | + +### Event `30017`: Create or update a stall. + +**Event Content** + +```json +{ + "id": , + "name": , + "description": , + "currency": , + "shipping": [ + { + "id": , + "name": , + "cost": , + "regions": [] + } + ] +} +``` + +Fields that are not self-explanatory: + - `shipping`: + - an array with possible shipping zones for this stall. + - the customer MUST choose exactly one of those shipping zones. + - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero. + - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection. + - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per + product can also be specified if the shipping cost for that product is higher than what's specified by the base cost. + +**Event Tags** + +```jsonc +{ + "tags": [["d", , + "stall_id": , + "name": , + "description": , + "images": <[string], array of image URLs, optional>, + "currency": , + "price": , + "quantity": , + "specs": [ + [, ] + ], + "shipping": [ + { + "id": , + "cost": + } + ] +} +``` + +Fields that are not self-explanatory: + - `quantity` can be null in the case of items with unlimited availability, like digital items, or services + - `specs`: + - an optional array of key pair values. It allows for the Customer UI to present product specifications in a structure mode. It also allows comparison between products + - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` + + _Open_: better to move `spec` in the `tags` section of the event? + +- `shipping`: + - an _optional_ array of extra costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall + - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: + - the `base cost from the stall` for the chosen shipping option + - the result of multiplying the product units by the `shipping costs specified in the product`, if any. + +**Event Tags** + +```jsonc + "tags": [ + ["d", , + "type": 0, + "name": , + "address": , + "message": , + "contact": { + "nostr": <32-bytes hex of a pubkey>, + "phone": , + "email": + }, + "items": [ + { + "product_id": , + "quantity": + } + ], + "shipping_id": +} + +``` + +_Open_: is `contact.nostr` required? + + +### Step 2: `merchant` request payment (event) + +Sent back from the merchant for payment. Any payment option is valid that the merchant can check. + +The below JSON goes in `content` of [NIP-04](04.md). + +`payment_options`/`type` include: + +- `url` URL to a payment page, stripe, paypal, btcpayserver, etc +- `btc` onchain bitcoin address +- `ln` bitcoin lightning invoice +- `lnurl` bitcoin lnurl-pay + +```json +{ + "id": , + "type": 1, + "message": , + "payment_options": [ + { + "type": , + "link": + }, + { + "type": , + "link": + }, + { + "type": , + "link": + } + ] +} +``` + +### Step 3: `merchant` verify payment/shipped (event) + +Once payment has been received and processed. + +The below JSON goes in `content` of [NIP-04](04.md). + +```json +{ + "id": , + "type": 2, + "message": , + "paid": , + "shipped": , +} +``` + +## Customize Marketplace + +Create a customized user experience using the `naddr` from [NIP-19](19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. + +### Event `30019`: Create or update marketplace UI/UX + +**Event Content** + +```jsonc +{ + "name": , + "about": , + "ui": { + "picture": , + "banner": , + "theme": , + "darkMode": + }, + "merchants": [array of pubkeys (optional)], + // other fields... +} +``` + +This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment. + +## Auctions + +### Event `30020`: Create or update a product sold as an auction + +**Event Content**: +```json +{ + "id": , + "stall_id": , + "name": , + "description": , + "images": <[String], array of image URLs, optional>, + "starting_bid": , + "start_date": , + "duration": , + "specs": [ + [, ] + ], + "shipping": [ + { + "id": , + "cost": + } + ] +} +``` + +> [!NOTE] +> Items sold as an auction are very similar in structure to fixed-price items, with some important differences worth noting. + +* The `start_date` can be set to a date in the future if the auction is scheduled to start on that date, or can be omitted if the start date is unknown/hidden. If the start date is not specified, the auction will have to be edited later to set an actual date. + +* The auction runs for an initial number of seconds after the `start_date`, specified by `duration`. + +### Event `1021`: Bid + +```jsonc +{ + "content": , + "tags": [["e", ]], + // other fields... +} +``` + +Bids are simply events of kind `1021` with a `content` field specifying the amount, in the currency of the auction. Bids must reference an auction. + +> [!NOTE] +> Auctions can be edited as many times as desired (they are "addressable events") by the author - even after the start_date, but they cannot be edited after they have received the first bid! This is enforced by the fact that bids reference the event ID of the auction (rather than the product UUID), which changes with every new version of the auctioned product. So a bid is always attached to one "version". Editing the auction after a bid would result in the new product losing the bid! + +### Event `1022`: Bid confirmation + +**Event Content**: + +```json +{ + "status": , + "message": , + "duration_extended": +} +``` + +**Event Tags**: +```json + "tags": [["e" ], ["e", ]], +``` + +Bids should be confirmed by the merchant before being considered as valid by other clients. So clients should subscribe to *bid confirmation* events (kind `1022`) for every auction that they follow, in addition to the actual bids and should check that the pubkey of the bid confirmation matches the pubkey of the merchant (in addition to checking the signature). + +The `content` field is a JSON which includes *at least* a `status`. `winner` is how the *winning bid* is replied to after the auction ends and the winning bid is picked by the merchant. + +The reasons for which a bid can be marked as `rejected` or `pending` are up to the merchant's implementation and configuration - they could be anything from basic validation errors (amount too low) to the bidder being blacklisted or to the bidder lacking sufficient *trust*, which could lead to the bid being marked as `pending` until sufficient verification is performed. The difference between the two is that `pending` bids *might* get approved after additional steps are taken by the bidder, whereas `rejected` bids can not be later approved. + +An additional `message` field can appear in the `content` JSON to give further context as of why a bid is `rejected` or `pending`. + +Another thing that can happen is - if bids happen very close to the end date of the auction - for the merchant to decide to extend the auction duration for a few more minutes. This is done by passing a `duration_extended` field as part of a bid confirmation, which would contain a number of seconds by which the initial duration is extended. So the actual end date of an auction is always `start_date + duration + (SUM(c.duration_extended) FOR c in all confirmations`. + +## Customer support events + +Customer support is handled over whatever communication method was specified. If communicating via nostr, [NIP-04](04.md) is used. + +## Additional + +Standard data models can be found [here](https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py) diff --git a/docs/nips/16.md b/docs/nips/16.md new file mode 100644 index 00000000..00320832 --- /dev/null +++ b/docs/nips/16.md @@ -0,0 +1,9 @@ +NIP-16 +====== + +Event Treatment +--------------- + +`final` `mandatory` + +Moved to [NIP-01](01.md). diff --git a/docs/nips/17.md b/docs/nips/17.md new file mode 100644 index 00000000..2e0aabbf --- /dev/null +++ b/docs/nips/17.md @@ -0,0 +1,211 @@ +NIP-17 +====== + +Private Direct Messages +----------------------- + +`draft` `optional` + +This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. + +## Direct Message Kind + +Kind `14` is a chat message. `p` tags identify one or more receivers of the message. + +```jsonc +{ + "id": "", + "pubkey": "", + "created_at": "", + "kind": 14, + "tags": [ + ["p", "", ""], + ["p", "", ""], + ["e", "", ""] // if this is a reply + ["subject", ""], + // rest of tags... + ], + "content": "", +} +``` + +`.content` MUST be plain text. Fields `id` and `created_at` are required. + +An `e` tag denotes the direct parent message this post is replying to. + +`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). + +```json +["q", " or ", "", ""] +``` + +Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. + +## File Message Kind + +```jsonc +{ + "id": "", + "pubkey": "", + "created_at": "", + "kind": 15, + "tags": [ + ["p", "", ""], + ["p", "", ""], + ["e", "", "", "reply"], // if this is a reply + ["subject", ""], + ["file-type", ""], + ["encryption-algorithm", ""], + ["decryption-key", ""], + ["decryption-nonce", ""], + ["x", ""], + // rest of tags... + ], + "content": "" +} +``` + +Kind `15` is used for sending encrypted file event messages: + +- `file-type`: Specifies the MIME type of the attached file (e.g., `image/jpeg`, `audio/mpeg`, etc.) before encryption. +- `encryption-algorithm`: Indicates the encryption algorithm used for encrypting the file. Supported algorithms: `aes-gcm`. +- `decryption-key`: The decryption key that will be used by the recipient to decrypt the file. +- `decryption-nonce`: The decryption nonce that will be used by the recipient to decrypt the file. +- `content`: The URL of the file (``). +- `x` containing the SHA-256 hexencoded string of the encrypted file. +- `ox` containing the SHA-256 hexencoded string of the file before encryption. +- `size` (optional) size of the encrypted file in bytes +- `dim` (optional) size in pixels in the form `x` +- `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the client is loading the file +- `thumb` (optional) URL of thumbnail with same aspect ratio (encrypted with the same key, nonce) +- `fallback` (optional) zero or more fallback file sources in case `url` fails (encrypted with the same key, nonce) + +Just like kind `14`, kind `15`s MUST never be signed. + +## Chat Rooms + +The set of `pubkey` + `p` tags defines a chat room. If a new `p` tag is added or a current one is removed, a new room is created with a clean message history. + +Clients SHOULD render messages of the same room in a continuous thread. + +An optional `subject` tag defines the current name/topic of the conversation. Any member can change the topic by simply submitting a new `subject` to an existing `pubkey` + `p` tags room. There is no need to send `subject` in every message. The newest `subject` in the chat room is the subject of the conversation. + +## Encrypting + +Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat messages must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. + +```js +{ + "id": "", + "pubkey": randomPublicKey, + "created_at": randomTimeUpTo2DaysInThePast(), + "kind": 1059, // gift wrap + "tags": [ + ["p", receiverPublicKey, ""] // receiver + ], + "content": nip44Encrypt( + { + "id": "", + "pubkey": senderPublicKey, + "created_at": randomTimeUpTo2DaysInThePast(), + "kind": 13, // seal + "tags": [], // no tags + "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey), + "sig": "" + }, + randomPrivateKey, receiverPublicKey + ), + "sig": "" +} +``` + +The encryption algorithm MUST use the latest version of [NIP-44](44.md). + +Clients MUST verify if pubkey of the `kind:13` is the same pubkey on the `kind:14`, otherwise any sender can impersonate others by simply changing the pubkey on `kind:14`. + +Clients SHOULD randomize `created_at` in up to two days in the past in both the seal and the gift wrap to make sure grouping by `created_at` doesn't reveal any metadata. + +The gift wrap's `p` tag can be the receiver's main pubkey or an alias key created to receive DMs without exposing the receiver's identity. + +Clients CAN offer disappearing messages by setting an `expiration` tag in the gift wrap of each receiver or by not generating a gift wrap to the sender's public key + +## Publishing + +Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. + +```jsonc +{ + "kind": 10050, + "tags": [ + ["relay", "wss://inbox.nostr.wine"], + ["relay", "wss://myrelay.nostr1.com"], + ], + "content": "", + // other fields... +} +``` + +Clients SHOULD publish the gift-wrapped kind 1059 events that contain the sealed kind 14 (text) or kind 15 (file) rumors to the relays listed in the recipient’s kind 10050 event. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try. + +## Relays + +It's advisable that relays do not serve `kind:1059` to clients other than the ones tagged in them. + +It's advisable that users choose relays that conform to these practices. + +Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable. + +## Benefits & Limitations + +This NIP offers the following privacy and security features: + +1. **No Metadata Leak**: Participant identities, each message's real date and time, event kinds, and other event tags are all hidden from the public. Senders and receivers cannot be linked with public information alone. +2. **No Public Group Identifiers**: There is no public central queue, channel or otherwise converging identifier to correlate or count all messages in the same group. +3. **No Moderation**: There are no group admins: no invitations or bans. +4. **No Shared Secrets**: No secret must be known to all members that can leak or be mistakenly shared +5. **Fully Recoverable**: Messages can be fully recoverable by any client with the user's private key +6. **Optional Forward Secrecy**: Users and clients can opt-in for "disappearing messages". +7. **Uses Public Relays**: Messages can flow through public relays without loss of privacy. Private relays can increase privacy further, but they are not required. +8. **Cold Storage**: Users can unilaterally opt-in to sharing their messages with a separate key that is exclusive for DM backup and recovery. + +The main limitation of this approach is having to send a separate encrypted event to each receiver. Group chats with more than 100 participants should find a more suitable messaging scheme. + +## Implementation + +Clients implementing this NIP should by default only connect to the set of relays found in their `kind:10050` list. From that they should be able to load all messages both sent and received as well as get new live updates, making it for a very simple and lightweight implementation that should be fast. + +When sending a message to anyone, clients must then connect to the relays in the receiver's `kind:10050` and send the events there but can disconnect right after unless more messages are expected to be sent (e.g. the chat tab is still selected). Clients should also send a copy of their outgoing messages to their own `kind:10050` relay set. + +## Examples + +This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. + +The two final GiftWraps, one to the receiver and the other to the sender, respectively, are: + +```json +{ + "id":"2886780f7349afc1344047524540ee716f7bdc1b64191699855662330bf235d8", + "pubkey":"8f8a7ec43b77d25799281207e1a47f7a654755055788f7482653f9c9661c6d51", + "created_at":1703128320, + "kind":1059, + "tags":[ + ["p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"] + ], + "content":"AsqzdlMsG304G8h08bE67dhAR1gFTzTckUUyuvndZ8LrGCvwI4pgC3d6hyAK0Wo9gtkLqSr2rT2RyHlE5wRqbCOlQ8WvJEKwqwIJwT5PO3l2RxvGCHDbd1b1o40ZgIVwwLCfOWJ86I5upXe8K5AgpxYTOM1BD+SbgI5jOMA8tgpRoitJedVSvBZsmwAxXM7o7sbOON4MXHzOqOZpALpS2zgBDXSAaYAsTdEM4qqFeik+zTk3+L6NYuftGidqVluicwSGS2viYWr5OiJ1zrj1ERhYSGLpQnPKrqDaDi7R1KrHGFGyLgkJveY/45y0rv9aVIw9IWF11u53cf2CP7akACel2WvZdl1htEwFu/v9cFXD06fNVZjfx3OssKM/uHPE9XvZttQboAvP5UoK6lv9o3d+0GM4/3zP+yO3C0NExz1ZgFmbGFz703YJzM+zpKCOXaZyzPjADXp8qBBeVc5lmJqiCL4solZpxA1865yPigPAZcc9acSUlg23J1dptFK4n3Tl5HfSHP+oZ/QS/SHWbVFCtq7ZMQSRxLgEitfglTNz9P1CnpMwmW/Y4Gm5zdkv0JrdUVrn2UO9ARdHlPsW5ARgDmzaxnJypkfoHXNfxGGXWRk0sKLbz/ipnaQP/eFJv/ibNuSfqL6E4BnN/tHJSHYEaTQ/PdrA2i9laG3vJti3kAl5Ih87ct0w/tzYfp4SRPhEF1zzue9G/16eJEMzwmhQ5Ec7jJVcVGa4RltqnuF8unUu3iSRTQ+/MNNUkK6Mk+YuaJJs6Fjw6tRHuWi57SdKKv7GGkr0zlBUU2Dyo1MwpAqzsCcCTeQSv+8qt4wLf4uhU9Br7F/L0ZY9bFgh6iLDCdB+4iABXyZwT7Ufn762195hrSHcU4Okt0Zns9EeiBOFxnmpXEslYkYBpXw70GmymQfJlFOfoEp93QKCMS2DAEVeI51dJV1e+6t3pCSsQN69Vg6jUCsm1TMxSs2VX4BRbq562+VffchvW2BB4gMjsvHVUSRl8i5/ZSDlfzSPXcSGALLHBRzy+gn0oXXJ/447VHYZJDL3Ig8+QW5oFMgnWYhuwI5QSLEyflUrfSz+Pdwn/5eyjybXKJftePBD9Q+8NQ8zulU5sqvsMeIx/bBUx0fmOXsS3vjqCXW5IjkmSUV7q54GewZqTQBlcx+90xh/LSUxXex7UwZwRnifvyCbZ+zwNTHNb12chYeNjMV7kAIr3cGQv8vlOMM8ajyaZ5KVy7HpSXQjz4PGT2/nXbL5jKt8Lx0erGXsSsazkdoYDG3U", + "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480" +} +``` + +```json +{ + "id":"162b0611a1911cfcb30f8a5502792b346e535a45658b3a31ae5c178465509721", + "pubkey":"626be2af274b29ea4816ad672ee452b7cf96bbb4836815a55699ae402183f512", + "created_at":1702711587, + "kind":1059, + "tags":[ + ["p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"] + ], + "content":"AsTClTzr0gzXXji7uye5UB6LYrx3HDjWGdkNaBS6BAX9CpHa+Vvtt5oI2xJrmWLen+Fo2NBOFazvl285Gb3HSM82gVycrzx1HUAaQDUG6HI7XBEGqBhQMUNwNMiN2dnilBMFC3Yc8ehCJT/gkbiNKOpwd2rFibMFRMDKai2mq2lBtPJF18oszKOjA+XlOJV8JRbmcAanTbEK5nA/GnG3eGUiUzhiYBoHomj3vztYYxc0QYHOx0WxiHY8dsC6jPsXC7f6k4P+Hv5ZiyTfzvjkSJOckel1lZuE5SfeZ0nduqTlxREGeBJ8amOykgEIKdH2VZBZB+qtOMc7ez9dz4wffGwBDA7912NFS2dPBr6txHNxBUkDZKFbuD5wijvonZDvfWq43tZspO4NutSokZB99uEiRH8NAUdGTiNb25m9JcDhVfdmABqTg5fIwwTwlem5aXIy8b66lmqqz2LBzJtnJDu36bDwkILph3kmvaKPD8qJXmPQ4yGpxIbYSTCohgt2/I0TKJNmqNvSN+IVoUuC7ZOfUV9lOV8Ri0AMfSr2YsdZ9ofV5o82ClZWlWiSWZwy6ypa7CuT1PEGHzywB4CZ5ucpO60Z7hnBQxHLiAQIO/QhiBp1rmrdQZFN6PUEjFDloykoeHe345Yqy9Ke95HIKUCS9yJurD+nZjjgOxZjoFCsB1hQAwINTIS3FbYOibZnQwv8PXvcSOqVZxC9U0+WuagK7IwxzhGZY3vLRrX01oujiRrevB4xbW7Oxi/Agp7CQGlJXCgmRE8Rhm+Vj2s+wc/4VLNZRHDcwtfejogjrjdi8p6nfUyqoQRRPARzRGUnnCbh+LqhigT6gQf3sVilnydMRScEc0/YYNLWnaw9nbyBa7wFBAiGbJwO40k39wj+xT6HTSbSUgFZzopxroO3f/o4+ubx2+IL3fkev22mEN38+dFmYF3zE+hpE7jVxrJpC3EP9PLoFgFPKCuctMnjXmeHoiGs756N5r1Mm1ffZu4H19MSuALJlxQR7VXE/LzxRXDuaB2u9days/6muP6gbGX1ASxbJd/ou8+viHmSC/ioHzNjItVCPaJjDyc6bv+gs1NPCt0qZ69G+JmgHW/PsMMeL4n5bh74g0fJSHqiI9ewEmOG/8bedSREv2XXtKV39STxPweceIOh0k23s3N6+wvuSUAJE7u1LkDo14cobtZ/MCw/QhimYPd1u5HnEJvRhPxz0nVPz0QqL/YQeOkAYk7uzgeb2yPzJ6DBtnTnGDkglekhVzQBFRJdk740LEj6swkJ", + "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab" +} +``` diff --git a/docs/nips/18.md b/docs/nips/18.md new file mode 100644 index 00000000..83de12e7 --- /dev/null +++ b/docs/nips/18.md @@ -0,0 +1,40 @@ +NIP-18 +====== + +Reposts +------- + +`draft` `optional` + +A repost is a `kind 6` event that is used to signal to followers +that a `kind 1` text note is worth reading. + +The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended. +Reposts of [NIP-70](70.md)-protected events SHOULD always have an empty `content`. + +bitvid follows this guidance by serializing the full source event payload (including non-kind-1 targets) whenever it can be fetched from a relay, and falls back to an empty `content` only when the original note is protected or otherwise unavailable. + +The repost event MUST include an `e` tag with the `id` of the note that is +being reposted. That tag MUST include a relay URL as its third entry +to indicate where it can be fetched. + +The repost SHOULD include a `p` tag with the `pubkey` of the event being +reposted. + +## Quote Reposts + +Mentions to [NIP-21](21.md) entities like `nevent`, `note` and `naddr` on any +event must be converted into `q` tags. The `q` tag ensures quote reposts are +not pulled and included as replies in threads. It also allows you to easily +pull and count all of the quotes for a post. The syntax follows + +`["q", " or ", "", ""]` + +## Generic Reposts + +Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` +as a "generic repost", that can include any kind of event inside other than +`kind 1`. + +`kind 16` reposts SHOULD contain a `"k"` tag with the stringified kind number +of the reposted event as its value. diff --git a/docs/nips/19.md b/docs/nips/19.md new file mode 100644 index 00000000..4787ecd5 --- /dev/null +++ b/docs/nips/19.md @@ -0,0 +1,69 @@ +NIP-19 +====== + +bech32-encoded entities +----------------------- + +`draft` `optional` + +This NIP standardizes bech32-formatted strings that can be used to display keys, ids and other information in clients. These formats are not meant to be used anywhere in the core protocol, they are only meant for displaying to users, copy-pasting, sharing, rendering QR codes and inputting data. + +It is recommended that ids and keys are stored in either hex or binary format, since these formats are closer to what must actually be used the core protocol. + +## Bare keys and ids + +To prevent confusion and mixing between private keys, public keys and event ids, which are all 32 byte strings. bech32-(not-m) encoding with different prefixes can be used for each of these entities. + +These are the possible bech32 prefixes: + + - `npub`: public keys + - `nsec`: private keys + - `note`: note ids + +Example: the hex public key `3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d` translates to `npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6`. + +The bech32 encodings of keys and ids are not meant to be used inside the standard NIP-01 event formats or inside the filters, they're meant for human-friendlier display and input only. Clients should still accept keys in both hex and npub format for now, and convert internally. + +## Shareable identifiers with extra metadata + +When sharing a profile or an event, an app may decide to include relay information and other metadata such that other apps can locate and display these entities more easily. + +For these events, the contents are a binary-encoded list of `TLV` (type-length-value), with `T` and `L` being 1 byte each (`uint8`, i.e. a number in the range of 0-255), and `V` being a sequence of bytes of the size indicated by `L`. + +These are the possible bech32 prefixes with `TLV`: + + - `nprofile`: a nostr profile + - `nevent`: a nostr event + - `naddr`: a nostr _addressable event_ coordinate + - `nrelay`: a nostr relay (deprecated) + +These possible standardized `TLV` types are indicated here: + +- `0`: `special` + - depends on the bech32 prefix: + - for `nprofile` it will be the 32 bytes of the profile public key + - for `nevent` it will be the 32 bytes of the event id + - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For normal replaceable events use an empty string. +- `1`: `relay` + - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii + - this may be included multiple times +- `2`: `author` + - for `naddr`, the 32 bytes of the pubkey of the event + - for `nevent`, _optionally_, the 32 bytes of the pubkey of the event +- `3`: `kind` + - for `naddr`, the 32-bit unsigned integer of the kind, big-endian + - for `nevent`, _optionally_, the 32-bit unsigned integer of the kind, big-endian + +## Examples + +- `npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg` should decode into the public key hex `7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e` and vice-versa +- `nsec1vl029mgpspedva04g90vltkh6fvh240zqtv9k0t9af8935ke9laqsnlfe5` should decode into the private key hex `67dea2ed018072d675f5415ecfaed7d2597555e202d85b3d65ea4e58d2d92ffa` and vice-versa +- `nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p` should decode into a profile with the following TLV items: + - pubkey: `3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d` + - relay: `wss://r.x.com` + - relay: `wss://djbas.sadkb.com` + +## Notes + +- `npub` keys MUST NOT be used in NIP-01 events or in NIP-05 JSON responses, only the hex format is supported there. +- When decoding a bech32-formatted string, TLVs that are not recognized or supported should be ignored, rather than causing an error. diff --git a/docs/nips/20.md b/docs/nips/20.md new file mode 100644 index 00000000..6feed6a9 --- /dev/null +++ b/docs/nips/20.md @@ -0,0 +1,9 @@ +NIP-20 +====== + +Command Results +--------------- + +`final` `mandatory` + +Moved to [NIP-01](01.md). diff --git a/docs/nips/21.md b/docs/nips/21.md new file mode 100644 index 00000000..800e490d --- /dev/null +++ b/docs/nips/21.md @@ -0,0 +1,38 @@ +NIP-21 +====== + +`nostr:` URI scheme +------------------- + +`draft` `optional` + +This NIP standardizes the usage of a common URI scheme for maximum interoperability and openness in the network. + +The scheme is `nostr:`. + +The identifiers that come after are expected to be the same as those defined in [NIP-19](19.md) (except `nsec`). + +#### Examples + +- `nostr:npub1sn0wdenkukak0d9dfczzeacvhkrgz92ak56egt7vdgzn8pv2wfqqhrjdv9` +- `nostr:nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p` +- `nostr:note1fntxtkcy9pjwucqwa9mddn7v03wwwsu9j330jj350nvhpky2tuaspk6nqc` +- `nostr:nevent1qqstna2yrezu5wghjvswqqculvvwxsrcvu7uc0f78gan4xqhvz49d9spr3mhxue69uhkummnw3ez6un9d3shjtn4de6x2argwghx6egpr4mhxue69uhkummnw3ez6ur4vgh8wetvd3hhyer9wghxuet5nxnepm` + +### Linking HTML pages to Nostr entities + +`` tags with `rel="alternate"` can be used to associate webpages to Nostr events, in cases where the same content is served via the two mediums (for example, a web server that exposes Markdown articles both as HTML pages and as `kind:30023` events served under itself as a relay or through some other relay). For example: + +``` + + + +``` + +Likewise, `` tags with `rel="me"` or `rel="author"` can be used to assign authorship of webpages to Nostr profiles. For example: + +``` + + + +``` diff --git a/docs/nips/22.md b/docs/nips/22.md new file mode 100644 index 00000000..f356fa20 --- /dev/null +++ b/docs/nips/22.md @@ -0,0 +1,200 @@ +NIP-22 +====== + +Comment +------- + +`draft` `optional` + +A comment is a threading note always scoped to a root event or an [`I`-tag](73.md). + +It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting). + +Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`) +and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`). + +Comments MUST point to the authors when one is available (i.e. tagging a nostr event). `P` for the root scope +and `p` for the author of the parent item. + +```jsonc +{ + "kind": 1111, + "content": "", + "tags": [ + // root scope: event addresses, event ids, or I-tags. + ["", "", "", ""], + // the root item kind + ["K", ""], + + // pubkey of the author of the root scope event + ["P", "", "relay-url-hint"], + + // parent item: event addresses, event ids, or i-tags. + ["", "", "", ""], + // parent item kind + ["k", ""], + + // parent item pubkey + ["p", "", "relay-url-hint"] + ] + // other fields +} +``` + +Tags `K` and `k` MUST be present to define the event kind of the root and the parent items. + +`I` and `i` tags create scopes for hashtags, geohashes, URLs, and other external identifiers. + +The possible values for `i` tags – and `k` tags, when related to an external identity – are listed on [NIP-73](73.md). +Their uppercase versions use the same type of values but relate to the root item instead of the parent one. + +`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). + +```json +["q", " or ", "", ""] +``` + +`p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md). + +Comments MUST NOT be used to reply to kind 1 notes. [NIP-10](10.md) should instead be followed. + +## Examples + +A comment on a blog post looks like this: + +```jsonc +{ + "kind": 1111, + "content": "Great blog post!", + "tags": [ + // top-level comments scope to event addresses or ids + ["A", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], + // the root kind + ["K", "30023"], + // author of root event + ["P", "3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289", "wss://example.relay"] + + // the parent event address (same as root for top-level comments) + ["a", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], + // when the parent event is replaceable or addressable, also include an `e` tag referencing its id + ["e", "5b4fc7fed15672fefe65d2426f67197b71ccc82aa0cc8a9e94f683eb78e07651", "wss://example.relay"], + // the parent event kind + ["k", "30023"], + // author of the parent event + ["p", "3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289", "wss://example.relay"] + ] + // other fields +} +``` + +A comment on a [NIP-94](94.md) file looks like this: + +```jsonc +{ + "kind": 1111, + "content": "Great file!", + "tags": [ + // top-level comments have the same scope and reply to addresses or ids + ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], + // the root kind + ["K", "1063"], + // author of the root event + ["P", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], + + // the parent event id (same as root for top-level comments) + ["e", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], + // the parent kind + ["k", "1063"], + ["p", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"] + ] + // other fields +} +``` + +A reply to a comment looks like this: + +```jsonc +{ + "kind": 1111, + "content": "This is a reply to \"Great file!\"", + "tags": [ + // nip-94 file event id + ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], + // the root kind + ["K", "1063"], + ["P", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], + + // the parent event + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://example.relay", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"], + // the parent kind + ["k", "1111"], + ["p", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"] + ] + // other fields +} +``` + +A comment on a website's url looks like this: + +```jsonc +{ + "kind": 1111, + "content": "Nice article!", + "tags": [ + // referencing the root url + ["I", "https://abc.com/articles/1"], + // the root "kind": for an url + ["K", "web"], + + // the parent reference (same as root for top-level comments) + ["i", "https://abc.com/articles/1"], + // the parent "kind": for an url + ["k", "web"] + ] + // other fields +} +``` + +A podcast comment example: + +```jsonc +{ + "id": "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", + "pubkey": "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111", + "kind": 1111, + "content": "This was a great episode!", + "tags": [ + // podcast episode reference + ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"], + // podcast episode type + ["K", "podcast:item:guid"], + + // same value as "I" tag above, because it is a top-level comment (not a reply to a comment) + ["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"], + ["k", "podcast:item:guid"] + ] + // other fields +} +``` + +A reply to a podcast comment: + +```jsonc +{ + "kind": 1111, + "content": "I'm replying to the above comment.", + "tags": [ + // podcast episode reference + ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"], + // podcast episode type + ["K", "podcast:item:guid"], + + // this is a reference to the above comment + ["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"], + // the parent comment kind + ["k", "1111"] + ["p", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"] + ] + // other fields +} +``` diff --git a/docs/nips/23.md b/docs/nips/23.md new file mode 100644 index 00000000..2586ac0c --- /dev/null +++ b/docs/nips/23.md @@ -0,0 +1,66 @@ +NIP-23 +====== + +Long-form Content +----------------- + +`draft` `optional` + +This NIP defines `kind:30023` (an _addressable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. + +"Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. + +### Format + +The `.content` of these events should be a string text in Markdown syntax. To maximize compatibility and readability between different clients and devices, any client that is creating long form notes: + +- MUST NOT hard line-break paragraphs of text, such as arbitrary line breaks at 80 column boundaries. + +- MUST NOT support adding HTML to Markdown. + +### Metadata + +For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used. + +Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: + +- `"title"`, for the article title +- `"image"`, for a URL pointing to an image to be shown along with the title +- `"summary"`, for the article summary +- `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the article was published + +### Editability + +These articles are meant to be editable, so they should include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. + +### Linking + +The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. + +### References + +References to other Nostr notes, articles or profiles must be made according to [NIP-27](27.md), i.e. by using [NIP-21](21.md) `nostr:...` links and optionally adding tags for these (see example below). + +## Example Event + +```json +{ + "kind": 30023, + "created_at": 1675642635, + "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.", + "tags": [ + ["d", "lorem-ipsum"], + ["title", "Lorem Ipsum"], + ["published_at", "1296962229"], + ["t", "placeholder"], + ["e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", "wss://relay.example.com"], + ["a", "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", "wss://relay.nostr.org"] + ], + "pubkey": "...", + "id": "..." +} +``` + +### Replies & Comments + +Replies to `kind 30023` MUST use [NIP-22](./22.md) `kind 1111` comments. \ No newline at end of file diff --git a/docs/nips/24.md b/docs/nips/24.md new file mode 100644 index 00000000..0094d58d --- /dev/null +++ b/docs/nips/24.md @@ -0,0 +1,43 @@ +NIP-24 +====== + +Extra metadata fields and tags +------------------------------ + +`draft` `optional` + +This NIP keeps track of extra optional fields that can added to events which are not defined anywhere else but have become _de facto_ standards and other minor implementation possibilities that do not deserve their own NIP and do not have a place in other NIPs. + +### kind 0 + +These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events: + + - `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata. + - `website`: a web URL related in any way to the event author. + - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. + - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. + - `birthday`: an object representing the author's birth date. The format is { "year": number, "month": number, "day": number }. Each field MAY be omitted. + +#### Deprecated fields + +These are fields that should be ignored or removed when found in the wild: + + - `displayName`: use `display_name` instead. + - `username`: use `name` instead. + +### kind 3 + +These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events: + +#### Deprecated fields + + - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead. + +### tags + +These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: + + - `r`: a web URL the event is referring to in some way. + - `i`: an external id the event is referring to in some way - see [NIP-73](73.md). + - `title`: name of [NIP-51](51.md) sets, [NIP-52](52.md) calendar event, [NIP-53](53.md) live event or [NIP-99](99.md) listing. + - `t`: a hashtag. The value MUST be a lowercase string. diff --git a/docs/nips/25.md b/docs/nips/25.md new file mode 100644 index 00000000..7ac4fb18 --- /dev/null +++ b/docs/nips/25.md @@ -0,0 +1,100 @@ + +NIP-25 +====== + +Reactions +--------- + +`draft` `optional` + +A reaction is a `kind 7` event that is used to indicate user reactions to other events. A +reaction's `content` field MUST include user-generated-content indicating the value of the +reaction (conventionally `+`, `-`, or an emoji). + +A reaction with `content` set to `+` or an empty string MUST be interpreted as a "like" or "upvote". +A reaction with `content` set to `-` MUST be interpreted as a "dislike" or "downvote". + +A reaction with `content` set to an emoji or [NIP-30](30.md) custom emoji SHOULD NOT be interpreted +as a "like" or "dislike". Clients MAY instead display this emoji reaction on the post. + +Tags +---- + +There MUST be always an `e` tag set to the `id` of the event that is being reacted to. The `e` tag SHOULD include a relay hint pointing to a relay where the event being reacted to can be found. If a client decides to include other `e`, which not recommended, the target event `id` should be last of the `e` tags. + +There SHOULD be a `p` tag set to the `pubkey` of the event being reacted to. If a client decides to include other `p` tags, which not recommended, the target event `pubkey` should be last the `p` tags. + +If the event being reacted to is an addressable event, an `a` SHOULD be included together with the `e` tag, it must be set to the coordinates (`kind:pubkey:d-tag`) of the event being reacted to. + +The `e` and `a` tags SHOULD include relay and pubkey hints. The `p` tags SHOULD include relay hints. + +The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. + +**Example code** + +```swift +func make_like_event(pubkey: String, privkey: String, liked: NostrEvent, hint: String) -> NostrEvent { + var tags: [[String]] = [] + tags.append(["e", liked.id, hint, liked.pubkey]) + tags.append(["p", liked.pubkey, hint]) + tags.append(["k", String(liked.kind)]) + let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) + ev.calculate_id() + ev.sign(privkey: privkey) + return ev +} +``` + +External Content Reactions +--------------------- + +If the target of a reaction is not a native nostr event, the reaction MUST be a `kind 17` event and MUST include [NIP-73](73.md) external content `k` + `i` tags to properly reference the content. + +_Reacting to a website:_ +```jsonc +{ + "kind": 17, + "content": "⭐", + "tags": [ + ["k", "web"], + ["i", "https://example.com"] + ], +} +``` + +_Reacting to a podcast episode:_ +```jsonc +{ + "kind": 17, + "content": "+", + "tags": [ + ["k", "podcast:guid"], + ["i", "podcast:guid:917393e3-1b1e-5cef-ace4-edaa54e1f810", "https://fountain.fm/show/QRT0l2EfrKXNGDlRrmjL"], + ["k", "podcast:item:guid"], + ["i", "podcast:item:guid:PC20-229", "https://fountain.fm/episode/DQqBg5sD3qFGMCZoSuLF"] + ], +} +``` + + + + +Custom Emoji Reaction +--------------------- + +The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the +reaction content. The client should refer to the emoji tag and render the +content as an emoji if shortcode is specified. + +```jsonc +{ + "kind": 7, + "content": ":soapbox:", + "tags": [ + ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] + ], + // other fields... +} +``` + +The content can be set only one `:shortcode:`. And emoji tag should be one. diff --git a/docs/nips/26.md b/docs/nips/26.md new file mode 100644 index 00000000..645ec441 --- /dev/null +++ b/docs/nips/26.md @@ -0,0 +1,112 @@ +> __Warning__ `unrecommended`: adds unnecessary burden for little gain + +NIP-26 +======= + +Delegated Event Signing +----------------------- + +`draft` `optional` + +This NIP defines how events can be delegated so that they can be signed by other keypairs. + +Another application of this proposal is to abstract away the use of the 'root' keypairs when interacting with clients. For example, a user could generate new keypairs for each client they wish to use and authorize those keypairs to generate events on behalf of their root pubkey, where the root keypair is stored in cold storage. + +#### Introducing the 'delegation' tag + +This NIP introduces a new tag: `delegation` which is formatted as follows: + +```json +[ + "delegation", + , + , + +] +``` + +##### Delegation Token + +The **delegation token** should be a 64-byte Schnorr signature of the sha256 hash of the following string: + +``` +nostr:delegation:: +``` + +##### Conditions Query String + +The following fields and operators are supported in the above query string: + +*Fields*: +1. `kind` + - *Operators*: + - `=${KIND_NUMBER}` - delegatee may only sign events of this kind +2. `created_at` + - *Operators*: + - `<${TIMESTAMP}` - delegatee may only sign events created ***before*** the specified timestamp + - `>${TIMESTAMP}` - delegatee may only sign events created ***after*** the specified timestamp + +In order to create a single condition, you must use a supported field and operator. Multiple conditions can be used in a single query string, including on the same field. Conditions must be combined with `&`. + +For example, the following condition strings are valid: + +- `kind=1&created_at<1675721813` +- `kind=0&kind=1&created_at>1675721813` +- `kind=1&created_at>1674777689&created_at<1675721813` + +For the vast majority of use-cases, it is advisable that: +1. Query strings should include a `created_at` ***after*** condition reflecting the current time, to prevent the delegatee from publishing historic notes on the delegator's behalf. +2. Query strings should include a `created_at` ***before*** condition that is not empty and is not some extremely distant time in the future. If delegations are not limited in time scope, they expose similar security risks to simply using the root key for authentication. + +#### Example + +``` +# Delegator: +privkey: ee35e8bb71131c02c1d7e73231daa48e9953d329a4b701f7133c8f46dd21139c +pubkey: 8e0d3d3eb2881ec137a11debe736a9086715a8c8beeeda615780064d68bc25dd + +# Delegatee: +privkey: 777e4f60b4aa87937e13acc84f7abcc3c93cc035cb4c1e9f7a9086dd78fffce1 +pubkey: 477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396 +``` + +Delegation string to grant note publishing authorization to the delegatee (477318cf) from now, for the next 30 days, given the current timestamp is `1674834236`. +```json +nostr:delegation:477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396:kind=1&created_at>1674834236&created_at<1677426236 +``` + +The delegator (8e0d3d3e) then signs a SHA256 hash of the above delegation string, the result of which is the delegation token: +``` +6f44d7fe4f1c09f3954640fb58bd12bae8bb8ff4120853c4693106c82e920e2b898f1f9ba9bd65449a987c39c0423426ab7b53910c0c6abfb41b30bc16e5f524 +``` + +The delegatee (477318cf) can now construct an event on behalf of the delegator (8e0d3d3e). The delegatee then signs the event with its own private key and publishes. +```json +{ + "id": "e93c6095c3db1c31d15ac771f8fc5fb672f6e52cd25505099f62cd055523224f", + "pubkey": "477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396", + "created_at": 1677426298, + "kind": 1, + "tags": [ + [ + "delegation", + "8e0d3d3eb2881ec137a11debe736a9086715a8c8beeeda615780064d68bc25dd", + "kind=1&created_at>1674834236&created_at<1677426236", + "6f44d7fe4f1c09f3954640fb58bd12bae8bb8ff4120853c4693106c82e920e2b898f1f9ba9bd65449a987c39c0423426ab7b53910c0c6abfb41b30bc16e5f524" + ] + ], + "content": "Hello, world!", + "sig": "633db60e2e7082c13a47a6b19d663d45b2a2ebdeaf0b4c35ef83be2738030c54fc7fd56d139652937cdca875ee61b51904a1d0d0588a6acd6168d7be2909d693" +} +``` + +The event should be considered a valid delegation if the conditions are satisfied (`kind=1`, `created_at>1674834236` and `created_at<1677426236` in this example) and, upon validation of the delegation token, are found to be unchanged from the conditions in the original delegation string. + +Clients should display the delegated note as if it was published directly by the delegator (8e0d3d3e). + + +#### Relay & Client Support + +Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value. + +Relays SHOULD allow the delegator (8e0d3d3e) to delete the events published by the delegatee (477318cf). diff --git a/docs/nips/27.md b/docs/nips/27.md new file mode 100644 index 00000000..d75672ac --- /dev/null +++ b/docs/nips/27.md @@ -0,0 +1,54 @@ +NIP-27 +====== + +Text Note References +-------------------- + +`draft` `optional` + +This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023). + +When creating an event, clients should include mentions to other profiles and to other events in the middle of the `.content` using [NIP-21](21.md) codes, such as `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. + +Including [NIP-18](18.md)'s quote tags (`["q", " or ", "", ""]`) for each reference is optional, clients should do it whenever they want the profile being mentioned to be notified of the mention, or when they want the referenced event to recognize their mention as a reply. + +A reader client that receives an event with such `nostr:...` mentions in its `.content` can do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, [NIP-21](21.md) links or direct links to web clients that will handle these references. + +--- + +## Example of a profile mention process + +Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. + +As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://njump.me/npub1937vv2nf06360qn9y8el6d8sevnndy7tuh5nzre4gj05xc32tnwqauhaj6), showing a picture and name. + +Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this: + +```json +{ + "content": "hello nostr:nprofile1qqszclxx9f5haga8sfjjrulaxncvkfekj097t6f3pu65f86rvg49ehqj6f9dh", + "created_at": 1679790774, + "id": "f39e9b451a73d62abc5016cffdd294b1a904e2f34536a208874fe5e22bbd47cf", + "kind": 1, + "pubkey": "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798", + "sig": "f8c8bab1b90cc3d2ae1ad999e6af8af449ad8bb4edf64807386493163e29162b5852a796a8f474d6b1001cddbaac0de4392838574f5366f03cc94cf5dfb43f4d", + "tags": [ + [ + "p", + "2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc" + ] + ] +} +``` + +(Alternatively, the mention could have been a `nostr:npub1...` URL.) + +After Bob publishes this event and Carol sees it, her client will initially display the `.content` as it is, but later it will parse the `.content` and see that there is a `nostr:` URL in there, decode it, extract the public key from it (and possibly relay hints), fetch that profile from its internal database or relays, then replace the full URL with the name `@mattn`, with a link to the internal page view for that profile. + +## Verbose and probably unnecessary considerations + +- The example above was very concrete, but it doesn't mean all clients have to implement the same flow. There could be clients that do not support autocomplete at all, so they just allow users to paste raw [NIP-19](19.md) codes into the body of text, then prefix these with `nostr:` before publishing the event. +- The flow for referencing other events is similar: a user could paste a `note1...` or `nevent1...` code and the client will turn that into a `nostr:note1...` or `nostr:nevent1...` URL. Then upon reading such references the client may show the referenced note in a preview box or something like that -- or nothing at all. +- Other display procedures can be employed: for example, if a client that is designed for dealing with only `kind:1` text notes sees, for example, a [`kind:30023`](23.md) `nostr:naddr1...` URL reference in the `.content`, it can, for example, decide to turn that into a link to some hardcoded webapp capable of displaying such events. +- Clients may give the user the option to include or not include tags for mentioned events or profiles. If someone wants to mention `mattn` without notifying them, but still have a nice augmentable/clickable link to their profile inside their note, they can instruct their client to _not_ create a `["p", ...]` tag for that specific mention. +- In the same way, if someone wants to reference another note but their reference is not meant to show up along other replies to that same note, their client can choose to not include a corresponding `["e", ...]` tag for any given `nostr:nevent1...` URL inside `.content`. Clients may decide to expose these advanced functionalities to users or be more opinionated about things. diff --git a/docs/nips/28.md b/docs/nips/28.md new file mode 100644 index 00000000..6b240ef3 --- /dev/null +++ b/docs/nips/28.md @@ -0,0 +1,160 @@ + +NIP-28 +====== + +Public Chat +----------- + +`draft` `optional` + +This NIP defines new event kinds for public chat channels, channel messages, and basic client-side moderation. + +It reserves five event kinds (40-44) for immediate use: + +- `40 - channel create` +- `41 - channel metadata` +- `42 - channel message` +- `43 - hide message` +- `44 - mute user` + +Client-centric moderation gives client developers discretion over what types of content they want included in their apps, while imposing no additional requirements on relays. + +## Kind 40: Create channel + +Create a public chat channel. + +In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41). + +```jsonc +{ + "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", + // other fields... +} +``` + + +## Kind 41: Set channel metadata + +Update a channel's public metadata. + +Kind 41 is used to update the metadata without modifying the event id for the channel. Only the most recent kind 41 per `e` tag value MAY be available. + +Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. + +Clients SHOULD support basic metadata fields: + +- `name` - string - Channel name +- `about` - string - Channel description +- `picture` - string - URL of channel picture +- `relays` - array - List of relays to download and broadcast events to + +Clients MAY add additional metadata fields. + +Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. + +It is also possible to set the category name using the "t" tag. This category name can be searched and filtered. + +```jsonc +{ + "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", + "tags": [ + ["e", , , "root"], + ["t", ], + ["t", ], + ["t", ], + ], + // other fields... +} +``` + + +## Kind 42: Create channel message + +Send a text message to a channel. + +Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay and specify whether it is a reply or root message. + +Clients SHOULD append [NIP-10](10.md) "p" tags to replies. + +Root message: + +```jsonc +{ + "content": , + "tags": [["e", , , "root"]], + // other fields... +} +``` + +Reply to another message: + +```jsonc +{ + "content": , + "tags": [ + ["e", , , "root"], + ["e", , , "reply"], + ["p", , ], + // rest of tags... + ], + // other fields... +} +``` + + +## Kind 43: Hide message + +User no longer wants to see a certain message. + +The `content` may optionally include metadata such as a `reason`. + +Clients SHOULD hide event 42s shown to a given user, if there is an event 43 from that user matching the event 42 `id`. + +Clients MAY hide event 42s for other users other than the user who sent the event 43. + +(For example, if three users 'hide' an event giving a reason that includes the word 'pornography', a Nostr client that is an iOS app may choose to hide that message for all iOS clients.) + +```jsonc +{ + "content": "{\"reason\": \"Dick pic\"}", + "tags": [["e", ]], + // other fields... +} +``` + +## Kind 44: Mute user + +User no longer wants to see messages from another user. + +The `content` may optionally include metadata such as a `reason`. + +Clients SHOULD hide event 42s shown to a given user, if there is an event 44 from that user matching the event 42 `pubkey`. + +Clients MAY hide event 42s for users other than the user who sent the event 44. + +```jsonc +{ + "content": "{\"reason\": \"Posting dick pics\"}", + "tags": [["p", ]], + // other fields... +} +``` + +## Relay recommendations + +Clients SHOULD use the relay URLs of the metadata events. + +Clients MAY use any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay. + +Motivation +---------- +If we're solving censorship-resistant communication for social media, we may as well solve it also for Telegram-style messaging. + +We can bring the global conversation out from walled gardens into a true public square open to all. + + +Additional info +--------------- + +- [Chat demo PR with fiatjaf+jb55 comments](https://github.com/ArcadeCity/arcade/pull/28) +- [Conversation about NIP16](https://t.me/nostr_protocol/29566) diff --git a/docs/nips/29.md b/docs/nips/29.md new file mode 100644 index 00000000..601d63ad --- /dev/null +++ b/docs/nips/29.md @@ -0,0 +1,244 @@ +NIP-29 +====== + +Relay-based Groups +------------------ + +`draft` `optional` + +This NIP defines a standard for groups that are only writable by a closed set of users. They can be public for reading by external users or not. + +Groups are identified by a random string of any length that serves as an _id_. + +There is no way to create a group, what happens is just that relays (most likely when asked by users) will create rules around some specific ids so these ids can serve as an actual group, henceforth messages sent to that group will be subject to these rules. + +Normally a group will originally belong to one specific relay, but the community may choose to move the group to other relays or even fork the group so it exists in different forms -- still using the same _id_ -- across different relays. + +## Relay-generated events + +Relays are supposed to generate the events that describe group metadata and group admins. These are _addressable_ events signed by the relay keypair directly, with the group _id_ as the `d` tag. + +## Group identifier + +A group may be identified by a string in the format `'`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`. + +Group identifiers must be strings restricted to the characters `a-z0-9-_`, and SHOULD be random in order to avoid name collisions. + +When encountering just the `` without the `'`, clients MAY infer `_` as the group id, which is a special top-level group dedicated to relay-local discussions. + +## The `h` tag + +Events sent by users to groups (chat messages, text notes, moderation events etc) MUST have an `h` tag with the value set to the group _id_. + +## Timeline references + +In order to not be used out of context, events sent to these groups may contain references to previous events seen from the same relay in the `previous` tag. The choice of which previous events to pick belongs to the clients. The references are to be made using the first 8 characters (4 bytes) of any event in the last 50 events seen by the user in the relay, excluding events by themselves. There can be any number of references (including zero), but it's recommended that clients include at least 3 and that relays enforce this. + +This is a hack to prevent messages from being broadcasted to external relays that have forks of one group out of context. Relays are expected to reject any events that contain timeline references to events not found in their own database. Clients should also check these to keep relays honest about them. + +## Late publication + +Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay. + +## Group management + +Groups can have any number of users with elevated access. These users are identified by role labels which are arbitrarily defined by the relays (see also the description of `kind:39003`). What each role is capable of not defined in this NIP either, it's a relay policy that can vary. Roles can be assigned by other users (as long as they have the capability to add roles) by publishing a `kind:9000` event with that user's pubkey in a `p` tag and the roles afterwards (even if the user is already a group member a `kind:9000` can be issued and the user roles must just be updated). + +The roles supported by the group as to having some special privilege assigned to them should be accessible on the event `kind:39003`, but the relay may also accept other role names, arbitrarily defined by clients, and just not do anything with them. + +Users with any roles that have any privilege can be considered _admins_ in a broad sense and be returned in the `kind:39001` event for a group. + +## Unmanaged groups + +Unmanaged groups are impromptu groups that can be used in any public relay unaware of NIP-29 specifics. They piggyback on relays' natural white/blacklists (or lack of) but aside from that are not actively managed and won't have any admins, group state or metadata events. + +In `unmanaged` groups, everybody is considered to be a member. + +Unmanaged groups can transition to managed groups, in that case the relay master key just has to publish moderation events setting the state of all groups and start enforcing the rules they choose to. + +## Event definitions + +These are the events expected to be found in NIP-29 groups. + +### Normal user-created events + +Groups may accept any event kind, including chats, threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. + +### User-related group management events + +These are events that can be sent by users to manage their situation in a group, they also require the `h` tag. + +- *join request* (`kind:9021`) + +Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be rejected with `duplicate: ` as the error message prefix. + +```json +{ + "kind": 9021, + "content": "optional reason", + "tags": [ + ["h", ""], + ["code", ""] + ] +} +``` + +The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. + +- *leave request* (`kind:9022`) + +Any user can send one of these events to the relay in order to be automatically removed from the group. The relay will automatically issue a `kind:9001` in response removing this user. + +```json +{ + "kind": 9022, + "content": "optional reason", + "tags": [ + ["h", ""] + ] +} +``` + +### Group state -- or moderation + +These are events expected to be sent by the relay master key or by group admins -- and relays should reject them if they don't come from an authorized admin. They also require the `h` tag. + +- *moderation events* (`kinds:9000-9020`) (optional) + +Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action based on its role and the relay's internal policy (see also the description of `kind:39003`). + +```jsonc +{ + "kind": 90xx, + "content": "optional reason", + "tags": [ + ["h", ""], + ["previous", /*...*/] + ] +} +``` + +Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: + +| kind | name | tags | +| --- | --- | --- | +| 9000 | `put-user` | `p` with pubkey hex and optional roles | +| 9001 | `remove-user` | `p` with pubkey hex | +| 9002 | `edit-metadata` | fields from `kind:39000` to be modified | +| 9005 | `delete-event` | `e` with event id hex | +| 9007 | `create-group` | | +| 9008 | `delete-group` | | +| 9009 | `create-invite` | | + +It's expected that the group state (of who is an allowed member or not, who is an admin and with which permission or not, what are the group name and picture etc) can be fully reconstructed from the canonical sequence of these events. + +### Group metadata events + +These events contain the group id in a `d` tag instead of the `h` tag. They MUST be created by the relay master key only and a single instance of each (or none) should exist at all times for each group. They are merely informative but should reflect the latest group state (as it was changed by moderation events over time). + +- *group metadata* (`kind:39000`) (optional) + +This event defines the metadata for the group -- basically how clients should display it. It must be generated and signed by the relay in which is found. Relays shouldn't accept these events if they're signed by anyone else. + +If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. + +When this event is not found, clients may still connect to the group, but treat it as having a different status, `unmanaged`, + +```jsonc +{ + "kind": 39000, + "content": "", + "tags": [ + ["d", ""], + ["name", "Pizza Lovers"], + ["picture", "https://pizza.com/pizza.png"], + ["about", "a group for people who love pizza"], + ["public"], // or ["private"] + ["open"] // or ["closed"] + ] + // other fields... +} +``` + +`name`, `picture` and `about` are basic metadata for the group for display purposes. `public` signals the group can be _read_ by anyone, while `private` signals that only AUTHed users can read. `open` signals that anyone can request to join and the request will be automatically granted, while `closed` signals that members must be pre-approved or that requests to join will be manually handled. + +- *group admins* (`kind:39001`) (optional) + +Each admin is listed along with one or more roles. These roles SHOULD have a correspondence with the roles supported by the relay, as advertised by the `kind:39003` event. + +```jsonc +{ + "kind": 39001, + "content": "list of admins for the pizza lovers group", + "tags": [ + ["d", ""], + ["p", "", "ceo"], + ["p", "", "secretary", "gardener"], + // other pubkeys... + ], + // other fields... +} +``` + +- *group members* (`kind:39002`) (optional) + +It's a list of pubkeys that are members of the group. Relays might choose to not to publish this information, to restrict what pubkeys can fetch it or to only display a subset of the members in it. + +Clients should not assume this will always be present or that it will contain a full list of members. + +```jsonc +{ + "kind": 39002, + "content": "list of members for the pizza lovers group", + "tags": [ + ["d", ""], + ["p", ""], + ["p", ""], + ["p", ""], + // other pubkeys... + ], + // other fields... +} +``` + +- *group roles* (`kind:39003`) (optional) + +This is an event that MAY be published by the relay informing users and clients about what are the roles supported by this relay according to its internal logic. + +For example, a relay may choose to support the roles `"admin"` and `"moderator"`, in which the `"admin"` will be allowed to edit the group metadata, delete messages and remove users from the group, while the `"moderator"` can only delete messages (or the relay may choose to call these roles `"ceo"` and `"secretary"` instead, the exact role name is not relevant). + +The process through which the relay decides what roles to support and how to handle moderation events internally based on them is specific to each relay and not specified here. + +```jsonc +{ + "kind": 39003, + "content": "list of roles supported by this group", + "tags": [ + ["d", ""], + ["role", "", ""], + ["role", "", ""], + // other roles... + ], + // other fields... +} +``` + +## Implementation quirks + +### Checking your own membership in a group + +The latest of either `kind:9000` or `kind:9001` events present in a group should tell a user that they are currently members of the group or if they were removed. In case none of these exist the user is assumed to not be a member of the group -- unless the group is `unmanaged`, in which case the user is assumed to be a member. + +### Adding yourself to a group + +When a group is `open`, anyone can send a `kind:9021` event to it in order to be added, then expect a `kind:9000` event to be emitted confirming that the user was added. The same happens with `closed` groups, except in that case a user may only send a `kind:9021` if it has an invite code. + +### Storing your list of groups + +A definition for `kind:10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in. + +### Using `unmanaged` relays + +To prevent event leakage, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays. + +Groups MAY be named without relay support by adding a `name` to the corresponding tag in a user's `kind 10009` group list. diff --git a/docs/nips/30.md b/docs/nips/30.md new file mode 100644 index 00000000..54a8b375 --- /dev/null +++ b/docs/nips/30.md @@ -0,0 +1,72 @@ +NIP-30 +====== + +Custom Emoji +------------ + +`draft` `optional` + +Custom emoji may be added to **kind 0**, **kind 1**, **kind 7** ([NIP-25](25.md)) and **kind 30315** ([NIP-38](38.md)) events by including one or more `"emoji"` tags, in the form: + +``` +["emoji", , ] +``` + +Where: + +- `` is a name given for the emoji, which MUST be comprised of only alphanumeric characters and underscores. +- `` is a URL to the corresponding image file of the emoji. + +For each emoji tag, clients should parse emoji shortcodes (aka "emojify") like `:shortcode:` in the event to display custom emoji. + +Clients may allow users to add custom emoji to an event by including `:shortcode:` identifier in the event, and adding the relevant `"emoji"` tags. + +### Kind 0 events + +In kind 0 events, the `name` and `about` fields should be emojified. + +```json +{ + "kind": 0, + "content": "{\"name\":\"Alex Gleason :soapbox:\"}", + "tags": [ + ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682790000 +} +``` + +### Kind 1 events + +In kind 1 events, the `content` should be emojified. + +```json +{ + "kind": 1, + "content": "Hello :gleasonator: 😂 :ablobcatrainbow: :disputed: yolo", + "tags": [ + ["emoji", "ablobcatrainbow", "https://gleasonator.com/emoji/blobcat/ablobcatrainbow.png"], + ["emoji", "disputed", "https://gleasonator.com/emoji/Fun/disputed.png"], + ["emoji", "gleasonator", "https://gleasonator.com/emoji/Gleasonator/gleasonator.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682630000 +} +``` + +### Kind 7 events + +In kind 7 events, the `content` should be emojified. + +```json +{ + "kind": 7, + "content": ":dezh:", + "tags": [ + ["emoji", "dezh", "https://raw.githubusercontent.com/dezh-tech/brand-assets/main/dezh/logo/black-normal.svg"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682630000 +} +``` diff --git a/docs/nips/31.md b/docs/nips/31.md new file mode 100644 index 00000000..37e41306 --- /dev/null +++ b/docs/nips/31.md @@ -0,0 +1,15 @@ +NIP-31 +====== + +Dealing with unknown event kinds +-------------------------------- + +`draft` `optional` + +When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use an `alt` tag to write a short human-readable plaintext summary of what that event is about. + +The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. The content of the `alt` tag should provide enough context for a user that doesn't know anything about this event kind to understand what it is. + +These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. + +`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](89.md). diff --git a/docs/nips/32.md b/docs/nips/32.md new file mode 100644 index 00000000..202200af --- /dev/null +++ b/docs/nips/32.md @@ -0,0 +1,176 @@ +NIP-32 +====== + +Labeling +-------- + +`draft` `optional` + +This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification. + +New Tags: + +- `L` denotes a label namespace +- `l` denotes a label + +Label Namespace Tag +---- + +An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace +(such as an ISO standard) or reverse domain name notation. + +`L` tags are RECOMMENDED in order to support searching by namespace rather than by a specific tag. The special `ugc` +("user generated content") namespace MAY be used when the label content is provided by an end user. + +`L` tags starting with `#` indicate that the label target should be associated with the label's value. +This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. + +Label Tag +---- + +An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a mark matching an `L` +tag value in the same event. If no `L` tag is included, a mark SHOULD still be included. If none is +included, `ugc` is implied. + +Label Target +---- + +The label event MUST include one or more tags representing the object or objects being +labeled: `e`, `p`, `a`, `r`, or `t` tags. This allows for labeling of events, people, relays, +or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and +`p` tags. + +Content +------- + +Labels should be short, meaningful strings. Longer discussions, such as for an +explanation of why something was labeled the way it was, should go in the event's `content` field. + +Self-Reporting +------- + +`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events +with a kind other than 1985, labels refer to the event itself. + +Example events +-------------- + +A suggestion that multiple pubkeys be associated with the `permies` topic. + +```jsonc +{ + "kind": 1985, + "tags": [ + ["L", "#t"], + ["l", "permies", "#t"], + ["p", , ], + ["p", , ] + ], + // other fields... +} +``` + +A report flagging violence toward a human being as defined by ontology.example.com. + +```jsonc +{ + "kind": 1985, + "tags": [ + ["L", "com.example.ontology"], + ["l", "VI-hum", "com.example.ontology"], + ["p", , ], + ["p", , ] + ], + // other fields... +} +``` + +A moderation suggestion for a chat event. + +```jsonc +{ + "kind": 1985, + "tags": [ + ["L", "nip28.moderation"], + ["l", "approve", "nip28.moderation"], + ["e", , ] + ], + // other fields... +} +``` + +Assignment of a license to an event. + +```jsonc +{ + "kind": 1985, + "tags": [ + ["L", "license"], + ["l", "MIT", "license"], + ["e", , ] + ], + // other fields... +} +``` + +Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author +is labeling their note as being related to Milan, Italy using ISO 3166-2. + +```jsonc +{ + "kind": 1, + "tags": [ + ["L", "ISO-3166-2"], + ["l", "IT-MI", "ISO-3166-2"] + ], + "content": "It's beautiful here in Milan!", + // other fields... +} +``` + +Author is labeling their note language as English using ISO-639-1. + +```jsonc +{ + "kind": 1, + "tags": [ + ["L", "ISO-639-1"], + ["l", "en", "ISO-639-1"] + ], + "content": "English text", + // other fields... +} +``` + +Other Notes +----------- + +When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement +may be published. We have opted not to use addressable/replaceable events for this due to the +complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, +publishers SHOULD limit labeling events to a single namespace. + +Before creating a vocabulary, explore how your use case may have already been designed and +imitate that design if possible. Reverse domain name notation is encouraged to avoid +namespace clashes, but for the sake of interoperability all namespaces should be +considered open for public use, and not proprietary. In other words, if there is a +namespace that fits your use case, use it even if it points to someone else's domain name. + +Vocabularies MAY choose to fully qualify all labels within a namespace (for example, +`["l", "com.example.vocabulary:my-label"]`). This may be preferred when defining more +formal vocabularies that should not be confused with another namespace when querying +without an `L` tag. For these vocabularies, all labels SHOULD include the namespace +(rather than mixing qualified and unqualified labels). + +A good heuristic for whether a use case fits this NIP is whether labels would ever be unique. +For example, many events might be labeled with a particular place, topic, or pubkey, but labels +with specific values like "John Doe" or "3.18743" are not labels, they are values, and should +be handled in some other way. + + +Appendix: Known Ontologies +-------------------------- + +Below is a non-exhaustive list of ontologies currently in widespread use. + +- [social ontology categories](https://github.com/CLARIAH/awesome-humanities-ontologies) diff --git a/docs/nips/33.md b/docs/nips/33.md new file mode 100644 index 00000000..9c00d42c --- /dev/null +++ b/docs/nips/33.md @@ -0,0 +1,9 @@ +NIP-33 +====== + +Parameterized Replaceable Events +-------------------------------- + +`final` `mandatory` + +Renamed to "Addressable events" and moved to [NIP-01](01.md). diff --git a/docs/nips/34.md b/docs/nips/34.md new file mode 100644 index 00000000..d35c0eb2 --- /dev/null +++ b/docs/nips/34.md @@ -0,0 +1,248 @@ +NIP-34 +====== + +`git` stuff +----------- + +`draft` `optional` + +This NIP defines all the ways code collaboration using and adjacent to [`git`](https://git-scm.com/) can be done using Nostr. + +## Repository announcements + +Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events. By doing so the author asserts themselves as a maintainer and expresses a willingness to receive patches, bug reports and comments in general, unless `t` tag `personal-fork` is included. + +```jsonc +{ + "kind": 30617, + "content": "", + "tags": [ + ["d", ""], // usually kebab-case short name + ["name", ""], + ["description", "brief human-readable project description>"], + ["web", "", ...], // a webpage url, if the git server being used provides such a thing + ["clone", "", ...], // a url to be given to `git clone` so anyone can clone it + ["relays", "", ...], // relays that this repository will monitor for patches and issues + ["r", "", "euc"], + ["maintainers", "", ...], + ["t","personal-fork"], // optionally indicate author isn't a maintainer + ["t", ""], // hashtags labelling the repository + ] +} +``` + +The tags `web`, `clone`, `relays`, `maintainers` can have multiple values. + +The `r` tag annotated with the `"euc"` marker should be the commit ID of the earliest unique commit of this repo, made to identify it among forks and group it with other repositories hosted elsewhere that may represent essentially the same project. In most cases it will be the root commit of a repository. In case of a permanent fork between two projects, then the first commit after the fork should be used. + +Except `d`, all tags are optional. + +## Repository state announcements + +An optional source of truth for the state of branches and tags in a repository. + +```jsonc +{ + "kind": 30618, + "content": "", + "tags": [ + ["d", ""], // matches the identifier in the corresponding repository announcement + ["refs//",""] + ["HEAD", "ref: refs/heads/"] + ] +} +``` + +The `refs` tag may appear multiple times, or none. + +If no `refs` tags are present, the author is no longer tracking repository state using this event. This approach enables the author to restart tracking state at a later time unlike [NIP-09](09.md) deletion requests. + +The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: + +```jsonc +{ + "tags": [ + ["refs//", "", "", "", ...], + ] +} +``` + +## Patches and Pull Requests (PRs) + +Patches and PRs can be sent by anyone to any repository. Patches and PRs to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch and PR events SHOULD include an `a` tag pointing to that repository's announcement address. + +Patches SHOULD be used if each event is under 60kb, otherwise PRs SHOULD be used. + +### Patches + +Patches in a patch set SHOULD include a [NIP-10](10.md) `e` `reply` tag pointing to the previous patch. + +The first patch revision in a patch revision SHOULD include a [NIP-10](10.md) `e` `reply` to the original root patch. + +```jsonc +{ + "kind": 1617, + "content": "", // contents of + "tags": [ + ["a", "30617::"], + ["r", ""] // so clients can subscribe to all patches sent to a local git repo + ["p", ""], + ["p", ""], // optionally send the patch to another user to bring it to their attention + + ["t", "root"], // omitted for additional patches in a series + // for the first patch in a revision + ["t", "root-revision"], + + // optional tags for when it is desirable that the merged patch has a stable commit id + // these fields are necessary for ensuring that the commit resulting from applying a patch + // has the same id as it had in the proposer's machine -- all these tags can be omitted + // if the maintainer doesn't care about these things + ["commit", ""], + ["r", ""] // so clients can find existing patches for a specific commit + ["parent-commit", ""], + ["commit-pgp-sig", "-----BEGIN PGP SIGNATURE-----..."], // empty string for unsigned commit + ["committer", "", "", "", ""], + ] +} +``` + +The first patch in a series MAY be a cover letter in the format produced by `git format-patch`. + +### Pull Requests + +The PR or PR update tip SHOULD be successfully pushed to `refs/nostr/<[PR|PR-Update]-event-id>` in all repositories listed in its `clone` tag before the event is signed. + +An attempt SHOULD be made to push this ref to all repositories listed in the repository's announcement event's `"clone"` tag, for which their is reason to believe the user might have write access. This includes each [grasp server](https://njump.me/naddr1qvzqqqrhnypzpgqgmmc409hm4xsdd74sf68a2uyf9pwel4g9mfdg8l5244t6x4jdqy28wumn8ghj7un9d3shjtnwva5hgtnyv4mqqpt8wfshxuqlnvh8x) which can be identified using this method: `clone` tag includes `[http|https]:////.git` and `relays` tag includes `[ws/wss]://`. + +Clients MAY fallback to creating a 'personal-fork' `repository announcement` listing other grasp servers, e.g. from the `User grasp list`, for the purpose of serving the specified commit(s). + +```jsonc +{ + "kind": 1618, + "content": "", + "tags": [ + ["a", "30617::"], + ["r", ""] // so clients can subscribe to all PRs sent to a local git repo + ["p", ""], + ["p", ""], // optionally send the PR to another user to bring it to their attention + + ["subject", ""], + ["t", ""], // optional + ["t", ""], // optional + + ["c", ""], // tip of the PR branch + ["clone", "", ...], // at least one git clone url where commit can be downloaded + ["branch-name", ""], // optional recommended branch name + + ["e", ""], // optionally indicate PR is a revision of an existing patch, which should be closed + ["merge-base", ""], // optional: the most recent common ancestor with the target branch + ] +} +``` + +### Pull Request Updates + +A PR Update changes the tip of a referenced PR event. + +```jsonc +{ + "kind": 1619, + "content": "", + "tags": [ + ["a", "30617::"], + ["r", ""] // so clients can subscribe to all PRs sent to a local git repo + ["p", ""], + ["p", ""], // optionally send the PR to another user to bring it to their attention + + // NIP-22 tags + ["E", ""], + ["P", ""], + + ["c", ""], // updated tip of PR + ["clone", "", ...], // at least one git clone url where commit can be downloaded + ["merge-base", ""], // optional: the most recent common ancestor with the target branch + ] +} +``` + +## Issues + +Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. + +Issues may have a `subject` tag, which clients can utilize to display a header. Additionally, one or more `t` tags may be included to provide labels for the issue. + +```json +{ + "kind": 1621, + "content": "", + "tags": [ + ["a", "30617::"], + ["p", ""] + ["subject", ""] + ["t", ""] + ["t", ""] + ] +} +``` + +## Replies + +Replies to either a `kind:1621` (_issue_), `kind:1617` (_patch_) or `kind:1618` (_pull request_) event should follow [NIP-22 comment](22.md). + +## Status + +Root Patches, PRs and Issues have a Status that defaults to 'Open' and can be set by issuing Status events. + +```jsonc +{ + "kind": 1630, // Open + "kind": 1631, // Applied / Merged for Patches; Resolved for Issues + "kind": 1632, // Closed + "kind": 1633, // Draft + "content": "", + "tags": [ + ["e", "", "", "root"], + ["e", "", "", "reply"], // for when revisions applied + ["p", ""], + ["p", ""], + ["p", ""], + + // optional for improved subscription filter efficiency + ["a", "30617::", ""], + ["r", ""] + + // optional for `1631` status + ["q", "", "", ""], // for each + // when merged + ["merge-commit", ""] + ["r", ""] + // when applied + ["applied-as-commits", "", ...] + ["r", ""] // for each + ] +} +``` + +The most recent Status event (by `created_at` date) from either the issue/patch author or a maintainer is considered valid. + +The Status of a patch-revision is to either that of the root-patch, or `1632` (_Closed_) if the root-patch's Status is `1631` (_Applied/Merged_) and the patch-revision isn't tagged in the `1631` (_Applied/Merged_) event. + +## User grasp list + +List of [grasp servers](https://njump.me/naddr1qvzqqqrhnypzpgqgmmc409hm4xsdd74sf68a2uyf9pwel4g9mfdg8l5244t6x4jdqy28wumn8ghj7un9d3shjtnwva5hgtnyv4mqqpt8wfshxuqlnvh8x) the user generally wishes to use for NIP-34 related activity. It is similar in function to the NIP-65 relay list and NIP-B7 blossom list. + +The event SHOULD include a list of `g` tags with grasp service websocket URLs in order of preference. + +```jsonc +{ + "kind": 10317, + "content": "", + "tags": [ + ["g", ""], // zero or more grasp sever urls + ] +} +``` + +## Possible things to be added later + +- inline file comments kind (we probably need one for patches and a different one for merged files) diff --git a/docs/nips/35.md b/docs/nips/35.md new file mode 100644 index 00000000..3891f6f4 --- /dev/null +++ b/docs/nips/35.md @@ -0,0 +1,70 @@ +NIP-35 +====== + +Torrents +-------- + +`draft` `optional` + +This NIP defined a new `kind 2003` which is a Torrent. + +`kind 2003` is a simple torrent index where there is enough information to search for content and construct the magnet link. No torrent files exist on nostr. + +## Tags +- `x`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` +- `file`: A file entry inside the torrent, including the full path ie. `info/example.txt` +- `tracker`: (Optional) A tracker to use for this torrent + +In order to make torrents searchable by general category, you SHOULD include a few tags like `movie`, `tv`, `HD`, `UHD` etc. + +## Tag prefixes + +Tag prefixes are used to label the content with references, ie. `["i", "imdb:1234"]` + +- `tcat`: A comma separated text category path, ie. `["i", "tcat:video,movie,4k"]`, this should also match the `newznab` category in a best effort approach. +- `newznab`: The category ID from [newznab](https://github.com/Prowlarr/Prowlarr/blob/develop/src/NzbDrone.Core/Indexers/NewznabStandardCategory.cs) +- `tmdb`: [The movie database](https://www.themoviedb.org/) id. +- `ttvdb`: [TV database](https://thetvdb.com/) id. +- `imdb`: [IMDB](https://www.imdb.com/) id. +- `mal`: [MyAnimeList](https://myanimelist.net/) id. +- `anilist`: [AniList](https://anilist.co/) id. + +A second level prefix should be included where the database supports multiple media types. +- `tmdb:movie:693134` maps to `themoviedb.org/movie/693134` +- `ttvdb:movie:290272` maps to `thetvdb.com/movies/dune-part-two` +- `mal:anime:9253` maps to `myanimelist.net/anime/9253` +- `mal:manga:17517` maps to `myanimelist.net/manga/17517` + +In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish. + +```json +{ + "kind": 2003, + "content": "", + "tags": [ + ["title", ""], + ["x", ""], + ["file", "", ""], + ["file", "", ""], + ["tracker", "udp://mytacker.com:1337"], + ["tracker", "http://1337-tracker.net/announce"], + ["i", "tcat:video,movie,4k"], + ["i", "newznab:2045"], + ["i", "imdb:tt15239678"], + ["i", "tmdb:movie:693134"], + ["i", "ttvdb:movie:290272"], + ["t", "movie"], + ["t", "4k"], + ] +} +``` + +## Torrent Comments + +A torrent comment is a `kind 2004` event which is used to reply to a torrent event. + +This event works exactly like a `kind 1` and should follow `NIP-10` for tagging. + +## Implementations +1. [dtan.xyz](https://git.v0l.io/Kieran/dtan) +2. [nostrudel.ninja](https://github.com/hzrd149/nostrudel/tree/next/src/views/torrents) \ No newline at end of file diff --git a/docs/nips/36.md b/docs/nips/36.md new file mode 100644 index 00000000..b10262c2 --- /dev/null +++ b/docs/nips/36.md @@ -0,0 +1,41 @@ +NIP-36 +====== + +Sensitive Content / Content Warning +----------------------------------- + +`draft` `optional` + +The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown. +Clients can hide the content until the user acts on it. + +`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) with the `content-warning` or other namespace to support +further qualification and querying. + +#### Spec + +``` +tag: content-warning +options: + - [reason]: optional +``` + +#### Example + +```json +{ + "pubkey": "", + "created_at": 1000000000, + "kind": 1, + "tags": [ + ["t", "hastag"], + ["L", "content-warning"], + ["l", "reason", "content-warning"], + ["L", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"], + ["content-warning", ""] + ], + "content": "sensitive content with #hastag\n", + "id": "" +} +``` diff --git a/docs/nips/37.md b/docs/nips/37.md new file mode 100644 index 00000000..ca0fdfb8 --- /dev/null +++ b/docs/nips/37.md @@ -0,0 +1,57 @@ +NIP-37 +====== + +Draft Wraps +----------- + +`draft` `optional` + +This NIP defines kind `31234` as an encrypted storage for unsigned draft events of any other kind. + +The draft is JSON-stringified, [NIP44-encrypted](44.md) to the signer's public key and placed inside the `.content`. + +`k` tags identify the kind of the draft. + +```js +{ + "kind": 31234, + "tags": [ + ["d", ""], + ["k", ""], // required + ["expiration", "now + 90 days"] // recommended + ], + "content": nip44Encrypt(JSON.stringify(draft_event)), + // other fields +} +``` + +A blanked `.content` field signals that the draft has been deleted. + +[NIP-40](40.md) `expiration` tags are recommended. + +Clients SHOULD publish kind `31234` events to relays listed on kind `10013` below. + +## Relay List for Private Content + +Kind `10013` indicates the user's preferred relays to store private events like Draft Wraps. + +The event MUST include a list of `relay` URLs in private tags. Private tags are JSON Stringified, [NIP44-encrypted](44.md) to the signer's keys and placed inside the .content of the event. + +```js +{ + "kind": 10013, + "tags": [], + "content": nip44Encrypt( + JSON.stringify( + [ + ["relay", "wss://myrelay.mydomain.com"] + ] + ) + ) + //...other fields +} +``` + +It's recommended that Private Storage relays SHOULD be [NIP-42](42.md)-authed and only allow downloads of events signed by the authed user. + +Clients MUST publish kind `10013` events to the author's [NIP-65](65.md) `write` relays. diff --git a/docs/nips/38.md b/docs/nips/38.md new file mode 100644 index 00000000..27359f1b --- /dev/null +++ b/docs/nips/38.md @@ -0,0 +1,63 @@ + +NIP-38 +====== + +User Statuses +------------- + +`draft` `optional` + +## Abstract + +This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. + +## Live Statuses + +A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _addressable event_, where the `d` tag represents the status type: + +For example: + +```json +{ + "kind": 30315, + "content": "Sign up for nostrasia!", + "tags": [ + ["d", "general"], + ["r", "https://nostr.world"] + ], +} +``` + +```json +{ + "kind": 30315, + "content": "Intergalatic - Beastie Boys", + "tags": [ + ["d", "music"], + ["r", "spotify:search:Intergalatic%20-%20Beastie%20Boys"], + ["expiration", "1692845589"] + ], +} +``` + +Two common status types are defined: `general` and `music`. `general` represent general statuses: "Working", "Hiking", etc. + +`music` status events are for live streaming what you are currently listening to. The expiry of the `music` status should be when the track will stop playing. + +Any other status types can be used but they are not defined by this NIP. + +The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or addressable event. + +The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. + +## Client behavior + +Clients MAY display this next to the username on posts or profiles to provide live user status information. + +## Use Cases + +* Calendar nostr apps that update your general status when you're in a meeting +* Nostr Nests that update your general status with a link to the nest when you join +* Nostr music streaming services that update your music status when you're listening +* Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well +* Clients can use the system media player to update playing music status diff --git a/docs/nips/39.md b/docs/nips/39.md new file mode 100644 index 00000000..3777ac55 --- /dev/null +++ b/docs/nips/39.md @@ -0,0 +1,67 @@ +NIP-39 +====== + +External Identities in Profiles +------------------------------- + +`draft` `optional` + +## Abstract + +Nostr protocol users may have other online identities such as usernames, profile pages, keypairs etc. they control and they may want to include this data in their profile metadata so clients can parse, validate and display this information. + +## `i` tag on a metadata event + +A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): + +```jsonc +{ + "id": , + "pubkey": , + "tags": [ + ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], + ["i", "twitter:semisol_public", "1619358434134196225"], + ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] + ["i", "telegram:1087295469", "nostrdirectory/770"] + ], + // other fields... +} +``` + +An `i` tag will have two parameters, which are defined as the following: +1. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`. +2. `proof`: String or object that points to the proof of owning this identity. + +Clients SHOULD process any `i` tags with more than 2 values for future extensibility. +Identity provider names SHOULD only include `a-z`, `0-9` and the characters `._-/` and MUST NOT include `:`. +Identity names SHOULD be normalized if possible by replacing uppercase letters with lowercase letters, and if there are multiple aliases for an entity the primary one should be used. + +## Claim types + +### `github` + +Identity: A GitHub username. + +Proof: A GitHub Gist ID. This Gist should be created by `` with a single file that has the text `Verifying that I control the following Nostr public key: `. +This can be located at `https://gist.github.com//`. + +### `twitter` + +Identity: A Twitter username. + +Proof: A Tweet ID. The tweet should be posted by `` and have the text `Verifying my account on nostr My Public Key: ""`. +This can be located at `https://twitter.com//status/`. + +### `mastodon` + +Identity: A Mastodon instance and username in the format `/@`. + +Proof: A Mastodon post ID. This post should be published by `@` and have the text `Verifying that I control the following Nostr public key: ""`. +This can be located at `https:///`. + +### `telegram` + +Identity: A Telegram user ID. + +Proof: A string in the format `/` which points to a message published in the public channel or group with name `` and message ID ``. This message should be sent by user ID `` and have the text `Verifying that I control the following Nostr public key: ""`. +This can be located at `https://t.me/`. diff --git a/docs/nips/40.md b/docs/nips/40.md new file mode 100644 index 00000000..909747f5 --- /dev/null +++ b/docs/nips/40.md @@ -0,0 +1,59 @@ +NIP-40 +====== + +Expiration Timestamp +-------------------- + +`draft` `optional` + +The `expiration` tag enables users to specify a unix timestamp at which the message SHOULD be considered expired (by relays and clients) and SHOULD be deleted by relays. + +#### Spec + +``` +tag: expiration +values: + - [UNIX timestamp in seconds]: required +``` + +#### Example + +```json +{ + "pubkey": "", + "created_at": 1000000000, + "kind": 1, + "tags": [ + ["expiration", "1600000000"] + ], + "content": "This message will expire at the specified timestamp and be deleted by relays.\n", + "id": "" +} +``` + +Note: The timestamp should be in the same format as the created_at timestamp and should be interpreted as the time at which the message should be deleted by relays. + +Client Behavior +--------------- + +Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. Clients SHOULD NOT send expiration events to relays that do not support this NIP. + +Clients SHOULD ignore events that have expired. + +Relay Behavior +-------------- + +Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely. +Relays SHOULD NOT send expired events to clients, even if they are stored. +Relays SHOULD drop any events that are published to them if they are expired. +An expiration timestamp does not affect storage of ephemeral events. + +Suggested Use Cases +------------------- + +* Temporary announcements - This tag can be used to make temporary announcements. For example, an event organizer could use this tag to post announcements about an upcoming event. +* Limited-time offers - This tag can be used by businesses to make limited-time offers that expire after a certain amount of time. For example, a business could use this tag to make a special offer that is only available for a limited time. + +#### Warning +The events could be downloaded by third parties as they are publicly accessible all the time on the relays. +So don't consider expiring messages as a security feature for your conversations or other uses. diff --git a/docs/nips/42.md b/docs/nips/42.md new file mode 100644 index 00000000..24f7f5d9 --- /dev/null +++ b/docs/nips/42.md @@ -0,0 +1,109 @@ +NIP-42 +====== + +Authentication of clients to relays +----------------------------------- + +`draft` `optional` + +This NIP defines a way for clients to authenticate to relays by signing an ephemeral event. + +## Motivation + +A relay may want to require clients to authenticate to access restricted resources. For example, + + - A relay may request payment or other forms of whitelisting to publish events -- this can naïvely be achieved by limiting publication to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an authenticated user; + - A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication before clients can query for that kind. + - A relay may limit subscriptions of any kind to paying users or users whitelisted through any other means, and require authentication. + +## Definitions + +### New client-relay protocol messages + +This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form: + +``` +["AUTH", ] +``` + +And, when sent by clients, the following form: + +``` +["AUTH", ] +``` + +Clients MAY provide signed events from multiple pubkeys in a sequence of `AUTH` messages. Relays MUST treat all pubkeys as authenticated accordingly. + +`AUTH` messages sent by clients MUST be answered with an `OK` message, like any `EVENT` message. + +### Canonical authentication event + +The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example: + +```jsonc +{ + "kind": 22242, + "tags": [ + ["relay", "wss://relay.example.com/"], + ["challenge", "challengestringhere"] + ], + // other fields... +} +``` + +### `OK` and `CLOSED` machine-readable prefixes + +This NIP defines two new prefixes that can be used in `OK` (in response to event writes by clients) and `CLOSED` (in response to rejected subscriptions by clients): + +- `"auth-required: "` - for when a client has not performed `AUTH` and the relay requires that to fulfill the query or write the event. +- `"restricted: "` - for when a client has already performed `AUTH` but the key used to perform it is still not allowed by the relay or is exceeding its authorization. + +## Protocol flow + +At any moment the relay may send an `AUTH` message to the client containing a challenge. The challenge is valid for the duration of the connection or until another challenge is sent by the relay. The client MAY decide to send its `AUTH` event at any point and the authenticated session is valid afterwards for the duration of the connection. + +### `auth-required` in response to a `REQ` message + +Given that a relay is likely to require clients to perform authentication only for certain jobs, like answering a `REQ` or accepting an `EVENT` write, these are some expected common flows: + +``` +relay: ["AUTH", ""] +client: ["REQ", "sub_1", {"kinds": [4]}] +relay: ["CLOSED", "sub_1", "auth-required: we can't serve DMs to unauthenticated users"] +client: ["AUTH", {"id": "abcdef...", ...}] +client: ["AUTH", {"id": "abcde2...", ...}] +relay: ["OK", "abcdef...", true, ""] +relay: ["OK", "abcde2...", true, ""] +client: ["REQ", "sub_1", {"kinds": [4]}] +relay: ["EVENT", "sub_1", {...}] +relay: ["EVENT", "sub_1", {...}] +relay: ["EVENT", "sub_1", {...}] +relay: ["EVENT", "sub_1", {...}] +... +``` + +In this case, the `AUTH` message from the relay could be sent right as the client connects or it can be sent immediately before the `CLOSED` is sent. The only requirement is that _the client must have a stored challenge associated with that relay_ so it can act upon that in response to the `auth-required` `CLOSED` message. + +### `auth-required` in response to an `EVENT` message + +The same flow is valid for when a client wants to write an `EVENT` to the relay, except now the relay sends back an `OK` message instead of a `CLOSED` message: + +``` +relay: ["AUTH", ""] +client: ["EVENT", {"id": "012345...", ...}] +relay: ["OK", "012345...", false, "auth-required: we only accept events from registered users"] +client: ["AUTH", {"id": "abcdef...", ...}] +relay: ["OK", "abcdef...", true, ""] +client: ["EVENT", {"id": "012345...", ...}] +relay: ["OK", "012345...", true, ""] +``` + +## Signed Event Verification + +To verify `AUTH` messages, relays must ensure: + + - that the `kind` is `22242`; + - that the event `created_at` is close (e.g. within ~10 minutes) of the current time; + - that the `"challenge"` tag matches the challenge sent before; + - that the `"relay"` tag matches the relay URL: + - URL normalization techniques can be applied. For most cases just checking if the domain name is correct should be enough. diff --git a/docs/nips/44.md b/docs/nips/44.md new file mode 100644 index 00000000..a7c13f12 --- /dev/null +++ b/docs/nips/44.md @@ -0,0 +1,297 @@ +NIP-44 +====== + +Encrypted Payloads (Versioned) +------------------------------ + +`optional` + +The NIP introduces a new data format for keypair-based encryption. This NIP is versioned +to allow multiple algorithm choices to exist simultaneously. This format may be used for +many things, but MUST be used in the context of a signed event as described in NIP-01. + +*Note*: this format DOES NOT define any `kind`s related to a new direct messaging standard, +only the encryption required to define one. It SHOULD NOT be used as a drop-in replacement +for NIP-04 payloads. + +## Versions + +Currently defined encryption algorithms: + +- `0x00` - Reserved +- `0x01` - Deprecated and undefined +- `0x02` - secp256k1 ECDH, HKDF, padding, ChaCha20, HMAC-SHA256, base64 + +## Limitations + +Every nostr user has their own public key, which solves key distribution problems present +in other solutions. However, nostr's relay-based architecture makes it difficult to implement +more robust private messaging protocols with things like metadata hiding, forward secrecy, +and post compromise secrecy. + +The goal of this NIP is to have a _simple_ way to encrypt payloads used in the context of a signed +event. When applying this NIP to any use case, it's important to keep in mind your users' threat +model and this NIP's limitations. For high-risk situations, users should chat in specialized E2EE +messaging software and limit use of nostr to exchanging contacts. + +On its own, messages sent using this scheme have a number of important shortcomings: + +- No deniability: it is possible to prove an event was signed by a particular key +- No forward secrecy: when a key is compromised, it is possible to decrypt all previous conversations +- No post-compromise security: when a key is compromised, it is possible to decrypt all future conversations +- No post-quantum security: a powerful quantum computer would be able to decrypt the messages +- IP address leak: user IP may be seen by relays and all intermediaries between user and relay +- Date leak: `created_at` is public, since it is a part of NIP-01 event +- Limited message size leak: padding only partially obscures true message length +- No attachments: they are not supported + +Lack of forward secrecy may be partially mitigated by only sending messages to trusted relays, and asking +relays to delete stored messages after a certain duration has elapsed. + +## Version 2 + +NIP-44 version 2 has the following design characteristics: + +- Payloads are authenticated using a MAC before signing rather than afterwards because events are assumed + to be signed as specified in NIP-01. The outer signature serves to authenticate the full payload, and MUST + be validated before decrypting. +- ChaCha is used instead of AES because it's faster and has + [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/). +- ChaCha is used instead of XChaCha because XChaCha has not been standardized. Also, xChaCha's improved collision + resistance of nonces isn't necessary since every message has a new (key, nonce) pair. +- HMAC-SHA256 is used instead of Poly1305 because polynomial MACs are much easier to forge. +- SHA256 is used instead of SHA3 or BLAKE because it is already used in nostr. Also BLAKE's speed advantage + is smaller in non-parallel environments. +- A custom padding scheme is used instead of padmé because it provides better leakage reduction for small messages. +- Base64 encoding is used instead of another encoding algorithm because it is widely available, and is already used in nostr. + +### Encryption + +1. Calculate a conversation key + - Execute ECDH (scalar multiplication) of public key B by private key A + Output `shared_x` must be unhashed, 32-byte encoded x coordinate of the shared point + - Use HKDF-extract with sha256, `IKM=shared_x` and `salt=utf8_encode('nip44-v2')` + - HKDF output will be a `conversation_key` between two users. + - It is always the same, when key roles are swapped: `conv(a, B) == conv(b, A)` +2. Generate a random 32-byte nonce + - Always use [CSPRNG](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator) + - Don't generate a nonce from message content + - Don't re-use the same nonce between messages: doing so would make them decryptable, + but won't leak the long-term key +3. Calculate message keys + - The keys are generated from `conversation_key` and `nonce`. Validate that both are 32 bytes long + - Use HKDF-expand, with sha256, `PRK=conversation_key`, `info=nonce` and `L=76` + - Slice 76-byte HKDF output into: `chacha_key` (bytes 0..32), `chacha_nonce` (bytes 32..44), `hmac_key` (bytes 44..76) +4. Add padding + - Content must be encoded from UTF-8 into byte array + - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes + - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` + - Padding algorithm is related to powers-of-two, with min padded msg size of 32 bytes + - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob +5. Encrypt padded content + - Use ChaCha20, with key and nonce from step 3 +6. Calculate MAC (message authentication code) + - AAD (additional authenticated data) is used - instead of calculating MAC on ciphertext, + it's calculated over a concatenation of `nonce` and `ciphertext` + - Validate that AAD (nonce) is 32 bytes +7. Base64-encode (with padding) params using `concat(version, nonce, ciphertext, mac)` + +Encrypted payloads MUST be included in an event's payload, hashed, and signed as defined in NIP 01, using schnorr +signature scheme over secp256k1. + +### Decryption + +Before decryption, the event's pubkey and signature MUST be validated as defined in NIP 01. The public key MUST be +a valid non-zero secp256k1 curve point, and the signature must be valid secp256k1 schnorr signature. For exact +validation rules, refer to BIP-340. + +1. Check if first payload's character is `#` + - `#` is an optional future-proof flag that means non-base64 encoding is used + - The `#` is not present in base64 alphabet, but, instead of throwing `base64 is invalid`, + implementations MUST indicate that the encryption version is not yet supported +2. Decode base64 + - Base64 is decoded into `version, nonce, ciphertext, mac` + - If the version is unknown, implementations must indicate that the encryption version is not supported + - Validate length of base64 message to prevent DoS on base64 decoder: it can be in range from 132 to 87472 chars + - Validate length of decoded message to verify output of the decoder: it can be in range from 99 to 65603 bytes +3. Calculate conversation key + - See step 1 of [encryption](#Encryption) +4. Calculate message keys + - See step 3 of [encryption](#Encryption) +5. Calculate MAC (message authentication code) with AAD and compare + - Stop and throw an error if MAC doesn't match the decoded one from step 2 + - Use constant-time comparison algorithm +6. Decrypt ciphertext + - Use ChaCha20 with key and nonce from step 3 +7. Remove padding + - Read the first two BE bytes of plaintext that correspond to plaintext length + - Verify that the length of sliced plaintext matches the value of the two BE bytes + - Verify that calculated padding from step 3 of the [encryption](#Encryption) process matches the actual padding + +### Details + +- Cryptographic methods + - `secure_random_bytes(length)` fetches randomness from CSPRNG. + - `hkdf(IKM, salt, info, L)` represents HKDF [(RFC 5869)](https://datatracker.ietf.org/doc/html/rfc5869) + with SHA256 hash function comprised of methods `hkdf_extract(IKM, salt)` and `hkdf_expand(OKM, info, L)`. + - `chacha20(key, nonce, data)` is ChaCha20 [(RFC 8439)](https://datatracker.ietf.org/doc/html/rfc8439) with + starting counter set to 0. + - `hmac_sha256(key, message)` is HMAC [(RFC 2104)](https://datatracker.ietf.org/doc/html/rfc2104). + - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by scalar a (`a ⋅ B`), defined in + [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki). + The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method + `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, + on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. + NIP44 doesn't do hashing of the output: keep this in mind, because some libraries hash it using sha256. + As an example, in libsecp256k1, unhashed version is available in `secp256k1_ec_pubkey_tweak_mul` +- Operators + - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the + `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. +- Constants `c`: + - `min_plaintext_size` is 1. 1 byte msg is padded to 32 bytes. + - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536 bytes. +- Functions + - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding) + - `concat` refers to byte array concatenation + - `is_equal_ct(a, b)` is constant-time equality check of 2 byte arrays + - `utf8_encode(string)` and `utf8_decode(bytes)` transform string to byte array and back + - `write_u8(number)` restricts number to values 0..255 and encodes into Big-Endian uint8 byte array + - `write_u16_be(number)` restricts number to values 0..65535 and encodes into Big-Endian uint16 byte array + - `zeros(length)` creates byte array of length `length >= 0`, filled with zeros + - `floor(number)` and `log2(number)` are well-known mathematical methods + +### Implementation pseudocode + +The following is a collection of python-like pseudocode functions which implement the above primitives, +intended to guide implementers. A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. + +```py +# Calculates length of the padded byte array. +def calc_padded_len(unpadded_len): + next_power = 1 << (floor(log2(unpadded_len - 1))) + 1 + if next_power <= 256: + chunk = 32 + else: + chunk = next_power / 8 + if unpadded_len <= 32: + return 32 + else: + return chunk * (floor((len - 1) / chunk) + 1) + +# Converts unpadded plaintext to padded bytearray +def pad(plaintext): + unpadded = utf8_encode(plaintext) + unpadded_len = len(plaintext) + if (unpadded_len < c.min_plaintext_size or + unpadded_len > c.max_plaintext_size): raise Exception('invalid plaintext length') + prefix = write_u16_be(unpadded_len) + suffix = zeros(calc_padded_len(unpadded_len) - unpadded_len) + return concat(prefix, unpadded, suffix) + +# Converts padded bytearray to unpadded plaintext +def unpad(padded): + unpadded_len = read_uint16_be(padded[0:2]) + unpadded = padded[2:2+unpadded_len] + if (unpadded_len == 0 or + len(unpadded) != unpadded_len or + len(padded) != 2 + calc_padded_len(unpadded_len)): raise Exception('invalid padding') + return utf8_decode(unpadded) + +# metadata: always 65b (version: 1b, nonce: 32b, max: 32b) +# plaintext: 1b to 0xffff +# padded plaintext: 32b to 0xffff +# ciphertext: 32b+2 to 0xffff+2 +# raw payload: 99 (65+32+2) to 65603 (65+0xffff+2) +# compressed payload (base64): 132b to 87472b +def decode_payload(payload): + plen = len(payload) + if plen == 0 or payload[0] == '#': raise Exception('unknown version') + if plen < 132 or plen > 87472: raise Exception('invalid payload size') + data = base64_decode(payload) + dlen = len(d) + if dlen < 99 or dlen > 65603: raise Exception('invalid data size'); + vers = data[0] + if vers != 2: raise Exception('unknown version ' + vers) + nonce = data[1:33] + ciphertext = data[33:dlen - 32] + mac = data[dlen - 32:dlen] + return (nonce, ciphertext, mac) + +def hmac_aad(key, message, aad): + if len(aad) != 32: raise Exception('AAD associated data must be 32 bytes'); + return hmac(sha256, key, concat(aad, message)); + +# Calculates long-term key between users A and B: `get_key(Apriv, Bpub) == get_key(Bpriv, Apub)` +def get_conversation_key(private_key_a, public_key_b): + shared_x = secp256k1_ecdh(private_key_a, public_key_b) + return hkdf_extract(IKM=shared_x, salt=utf8_encode('nip44-v2')) + +# Calculates unique per-message key +def get_message_keys(conversation_key, nonce): + if len(conversation_key) != 32: raise Exception('invalid conversation_key length') + if len(nonce) != 32: raise Exception('invalid nonce length') + keys = hkdf_expand(OKM=conversation_key, info=nonce, L=76) + chacha_key = keys[0:32] + chacha_nonce = keys[32:44] + hmac_key = keys[44:76] + return (chacha_key, chacha_nonce, hmac_key) + +def encrypt(plaintext, conversation_key, nonce): + (chacha_key, chacha_nonce, hmac_key) = get_message_keys(conversation_key, nonce) + padded = pad(plaintext) + ciphertext = chacha20(key=chacha_key, nonce=chacha_nonce, data=padded) + mac = hmac_aad(key=hmac_key, message=ciphertext, aad=nonce) + return base64_encode(concat(write_u8(2), nonce, ciphertext, mac)) + +def decrypt(payload, conversation_key): + (nonce, ciphertext, mac) = decode_payload(payload) + (chacha_key, chacha_nonce, hmac_key) = get_message_keys(conversation_key, nonce) + calculated_mac = hmac_aad(key=hmac_key, message=ciphertext, aad=nonce) + if not is_equal_ct(calculated_mac, mac): raise Exception('invalid MAC') + padded_plaintext = chacha20(key=chacha_key, nonce=chacha_nonce, data=ciphertext) + return unpad(padded_plaintext) + +# Usage: +# conversation_key = get_conversation_key(sender_privkey, recipient_pubkey) +# nonce = secure_random_bytes(32) +# payload = encrypt('hello world', conversation_key, nonce) +# 'hello world' == decrypt(payload, conversation_key) +``` + +### Audit + +The v2 of the standard was audited by [Cure53](https://cure53.de) in December 2023. +Check out [audit-2023.12.pdf](https://github.com/paulmillr/nip44/blob/ce63c2eaf345e9f7f93b48f829e6bdeb7e7d7964/audit-2023.12.pdf) +and [auditor's website](https://cure53.de/audit-report_nip44-implementations.pdf). + +### Tests and code + +A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. + +We publish extensive test vectors. Instead of having it in the document directly, a sha256 checksum of vectors is provided: + + 269ed0f69e4c192512cc779e78c555090cebc7c785b609e338a62afc3ce25040 nip44.vectors.json + +Example of a test vector from the file: + +```json +{ + "sec1": "0000000000000000000000000000000000000000000000000000000000000001", + "sec2": "0000000000000000000000000000000000000000000000000000000000000002", + "conversation_key": "c41c775356fd92eadc63ff5a0dc1da211b268cbea22316767095b2871ea1412d", + "nonce": "0000000000000000000000000000000000000000000000000000000000000001", + "plaintext": "a", + "payload": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABee0G5VSK0/9YypIObAtDKfYEAjD35uVkHyB0F4DwrcNaCXlCWZKaArsGrY6M9wnuTMxWfp1RTN9Xga8no+kF5Vsb" +} +``` + +The file also contains intermediate values. A quick guidance with regards to its usage: + +- `valid.get_conversation_key`: calculate conversation_key from secret key sec1 and public key pub2 +- `valid.get_message_keys`: calculate chacha_key, chacha_nonce, hmac_key from conversation_key and nonce +- `valid.calc_padded_len`: take unpadded length (first value), calculate padded length (second value) +- `valid.encrypt_decrypt`: emulate real conversation. Calculate pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext. +- `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, their checksum is provided. +- `invalid.encrypt_msg_lengths` +- `invalid.get_conversation_key`: calculating conversation_key must throw an error +- `invalid.decrypt`: decrypting message content must throw an error diff --git a/docs/nips/45.md b/docs/nips/45.md new file mode 100644 index 00000000..8758c873 --- /dev/null +++ b/docs/nips/45.md @@ -0,0 +1,60 @@ +NIP-45 +====== + +Event Counts +------------ + +`draft` `optional` + +Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts. + +## Motivation + +Some queries a client may want to execute against connected relays are prohibitively expensive, for example, in order to retrieve follower counts for a given pubkey, a client must query all kind-3 events referring to a given pubkey only to count them. The result may be cached, either by a client or by a separate indexing server as an alternative, but both options erode the decentralization of the network by creating a second-layer protocol on top of Nostr. + +## Filters and return values + +This NIP defines the verb `COUNT`, which accepts a query id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result. + +``` +["COUNT", , ...] +``` + +Counts are returned using a `COUNT` response in the form `{"count": }`. Relays may use probabilistic counts to reduce compute requirements. +In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": , "approximate": }`. + +``` +["COUNT", , {"count": }] +``` + +Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message. + +## Examples + +### Followers count + +``` +["COUNT", , {"kinds": [3], "#p": []}] +["COUNT", , {"count": 238}] +``` + +### Count posts and reactions + +``` +["COUNT", , {"kinds": [1, 7], "authors": []}] +["COUNT", , {"count": 5}] +``` + +### Count posts approximately + +``` +["COUNT", , {"kinds": [1]}] +["COUNT", , {"count": 93412452, "approximate": true}] +``` + +### Relay refuses to count + +``` +["COUNT", , {"kinds": [1059], "#p": []}] +["CLOSED", , "auth-required: cannot count other people's DMs"] +``` diff --git a/docs/nips/46.md b/docs/nips/46.md new file mode 100644 index 00000000..17019649 --- /dev/null +++ b/docs/nips/46.md @@ -0,0 +1,226 @@ +NIP-46 +====== + +Nostr Remote Signing +-------------------- + +## Changes + +`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect, nip05 login is removed, create_account moved to another NIP. + +## Rationale + +Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface. + +This NIP describes a method for 2-way communication between a remote signer and a Nostr client. The remote signer could be, for example, a hardware device dedicated to signing Nostr events, while the client is a normal Nostr client. + +## Terminology + +- **user**: A person that is trying to use Nostr. +- **client**: A user-facing application that _user_ is looking at and clicking buttons in. This application will send requests to _remote-signer_. +- **remote-signer**: A daemon or server running somewhere that will answer requests from _client_, also known as "bunker". +- **client-keypair/pubkey**: The keys generated by _client_. Used to encrypt content and communicate with _remote-signer_. +- **remote-signer-keypair/pubkey**: The keys used by _remote-signer_ to encrypt content and communicate with _client_. This keypair MAY be same as _user-keypair_, but not necessarily. +- **user-keypair/pubkey**: The actual keys representing _user_ (that will be used to sign events in response to `sign_event` requests, for example). The _remote-signer_ generally has control over these keys. + +All pubkeys specified in this NIP are in hex format. + +## Overview + +1. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout; +2. A connection is established (see below), _remote-signer_ learns `client-pubkey`, _client_ learns `remote-signer-pubkey`. +3. _client_ uses `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; +4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. +5. _client_ requests `get_public_key` to learn `user-pubkey`. + +## Initiating a connection + +There are two ways to initiate a connection: + +### Direct connection initiated by _remote-signer_ + +_remote-signer_ provides connection token in the form: + +``` +bunker://?relay=&relay=&secret= +``` + +_user_ passes this token to _client_, which then sends `connect` request to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old secret. + +### Direct connection initiated by the _client_ + +_client_ provides a connection token using `nostrconnect://` as the protocol, and `client-pubkey` as the origin. Additional information should be passed as query parameters: + +- `relay` (required) - one or more relay urls on which the _client_ is listening for responses from the _remote-signer_. +- `secret` (required) - a short random string that the _remote-signer_ should return as the `result` field of its response. +- `perms` (optional) - a comma-separated list of permissions the _client_ is requesting be approved by the _remote-signer_ +- `name` (optional) - the name of the _client_ application +- `url` (optional) - the canonical url of the _client_ application +- `image` (optional) - a small image representing the _client_ application + +Here's an example: + +``` +nostrconnect://83f3b2ae6aa368e8275397b9c26cf550101d63ebaab900d19dd4a4429f5ad8f5?relay=wss%3A%2F%2Frelay1.example.com&perms=nip44_encrypt%2Cnip44_decrypt%2Csign_event%3A13%2Csign_event%3A14%2Csign_event%3A1059&name=My+Client&secret=0s8j2djs&relay=wss%3A%2F%2Frelay2.example2.com +``` + +_user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response. + +## Request Events `kind: 24133` + +```jsonc +{ + "kind": 24133, + "pubkey": , + "content": )>, + "tags": [["p", ]], +} +``` + +The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure: + +```jsonc +{ + "id": , + "method": , + "params": [array_of_strings] +} +``` + +- `id` is a random string that is a request ID. This same ID will be sent back in the response payload. +- `method` is the name of the method/command (detailed below). +- `params` is a positional array of string parameters. + +### Methods/Commands + +Each of the following are methods that the _client_ sends to the _remote-signer_. + +| Command | Params | Result | +| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | +| `connect` | `[, , ]` | "ack" OR `` | +| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified()` | +| `ping` | `[]` | "pong" | +| `get_public_key` | `[]` | `` | +| `nip04_encrypt` | `[, ]` | `` | +| `nip04_decrypt` | `[, ]` | `` | +| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | +| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | + +### Requested permissions + +The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip44_encrypt,sign_event:4` meaning permissions to call `nip44_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. + +## Response Events `kind:24133` + +```json +{ + "id": <id>, + "kind": 24133, + "pubkey": <remote-signer-pubkey>, + "content": <nip44(<response>)>, + "tags": [["p", <client-pubkey>]], + "created_at": <unix timestamp in seconds> +} +``` + +The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure: + +```json +{ + "id": <request_id>, + "result": <results_string>, + "error": <optional_error_string> +} +``` + +- `id` is the request ID that this response is for. +- `results` is a string of the result of the call (this can be either a string or a JSON stringified object) +- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request. + +## Example flow for signing an event + +- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` + +### Signature request + +```jsonc +{ + "kind": 24133, + "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", + "content": nip44({ + "id": <random_string>, + "method": "sign_event", + "params": [json_stringified(<{ + content: "Hello, I'm signing remotely", + kind: 1, + tags: [], + created_at: 1714078911 + }>)] + }), + "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey +} +``` + +### Response event + +```jsonc +{ + "kind": 24133, + "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", + "content": nip44({ + "id": <random_string>, + "result": json_stringified(<signed-event>) + }), + "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey +} +``` + +### Diagram + +![signing-example](https://i.nostr.build/P3gW.png) + + +## Auth Challenges + +An Auth Challenge is a response that a _remote-signer_ can send back when it needs the _user_ to authenticate via other means. The response `content` object will take the following form: + +```json +{ + "id": <request_id>, + "result": "auth_url", + "error": <URL_to_display_to_end_user> +} +``` + +_client_ should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the _remote-signer_ (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). + +### Example event signing request with auth challenge + +![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png) + +## Appendix + +### Announcing _remote-signer_ metadata + +_remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this: +```jsonc +{ + "names":{ + "_": <remote-signer-app-pubkey>, + }, + "nip46": { + "relays": ["wss://relay1","wss://relay2"...], + "nostrconnect_url": "https://remote-signer-domain.example/<nostrconnect>" + } +} +``` + +The `<remote-signer-app-pubkey>` MAY be used to verify the domain from _remote-signer_'s NIP-89 event (see below). `relays` SHOULD be used to construct a more precise `nostrconnect://` string for the specific `remote-signer`. `nostrconnect_url` template MAY be used to redirect users to _remote-signer_'s connection flow by replacing `<nostrconnect>` placeholder with an actual `nostrconnect://` string. + +### Remote signer discovery via NIP-89 + +_remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above. + +_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`. diff --git a/docs/nips/47.md b/docs/nips/47.md new file mode 100644 index 00000000..13037cb5 --- /dev/null +++ b/docs/nips/47.md @@ -0,0 +1,687 @@ +NIP-47 +====== + +Nostr Wallet Connect (NWC) +-------------------- + +`draft` `optional` + +## Rationale + +This NIP describes a way for clients to access a remote lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol. + +## Terms + +* **client**: Nostr app on any platform that wants to interact with a lightning wallet. +* **user**: The person using the **client**, and wants to connect their wallet to their **client**. +* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. + +## Theory of Operation + +Fundamentally NWC is communication between a **client** and **wallet service** by the means of E2E-encrypted direct messages over a nostr relay. The relay knows the kinds and tags of notes, but not the content of the encrypted payloads. The **user**'s identity key is not used to avoid linking payment activity to the user. Ideally unique keys are used for each individual connection. + + 1. **Users** who wish to use this NIP to allow **client(s)** to interact with their wallet must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. + + 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** (or the **client** on the user's behalf) wants to interact with the wallet. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. + + 3. When the **user** initiates a payment their nostr **client** create a `pay_invoice` request, encrypts it using a token from the URI, and sends it (kind 23194) to the relay(s) specified in the connection URI. The **wallet service** will be listening on those relays and will decrypt the request and then contact the **user's** wallet application to send the payment. The **wallet service** will know how to talk to the wallet application because the connection URI specified relay(s) that have access to the wallet app API. + + 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. + + 5. The **wallet service** may send encrypted notifications (kind 23197 or 23196) of wallet events (such as a received payment) to the **client**. + +## Events + +There are four event kinds: + +- `NIP-47 info event`: 13194 +- `NIP-47 request`: 23194 +- `NIP-47 response`: 23195 +- `NIP-47 notification event`: 23197 (23196 for backwards compatibility with NIP-04) + +### Info Event + +The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which capabilities it supports. + +The content should be a plaintext string with the supported capabilities space-separated, eg. `pay_invoice get_balance notifications`. + +If the **wallet service** supports notifications, the info event SHOULD contain a `notifications` tag with the supported notification types space-separated, eg. `payment_received payment_sent`. + +It should also contain supported encryption modes as described in the [Encryption](#encryption) section. For example: + +```jsonc +{ + "kind": 13194, + "tags": [ + ["encryption", "nip44_v2 nip04"], // List of supported encryption schemes as described in the Encryption section. + ["notifications", "payment_received payment_sent"] + // ... + ], + "content": "pay_invoice get_balance make_invoice lookup_invoice list_transactions get_info notifications", + // ... +} +``` + +### Request and Response Events + +Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **client** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. +Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. + +The content of requests and responses is encrypted with [NIP44](44.md), and is a JSON-RPCish object with a semi-fixed structure. + +**Important note for backwards-compatibility:** The initial version of the protocol used [NIP04](04.md). If a **wallet service** or client app does not include the `encryption` tag in the +`info` or request events, it should be assumed that the connection is using NIP04 for encryption. See the [Encryption](#encryption) section for more information. + +Example request: + +```js +{ + "kind" 23194, + "tags": [ + ["encryption", "nip44_v2"], + ["p", "03..." ] // public key of the wallet service. + // ... + ], + "content": nip44_encrypt({ // Encryption type corresponds to the `encryption` tag. + "method": "pay_invoice", // method, string + "params": { // params, object + "invoice": "lnbc50n1..." // command-related data + } + }), +} +``` + +Example response: + +```js +{ + "kind" 23195, + "tags": [ + ["p", "03..." ] // public key of the requesting client app + ["e", "1234"] // id of the request event this is responding to + // ... + ], + "content": nip44_encrypt({ // Encrypted using the scheme requested by the client. + "result_type": "pay_invoice", //indicates the structure of the result field + "error": { //object, non-null in case of error + "code": "UNAUTHORIZED", //string error code, see below + "message": "human readable error message" + }, + "result": { // result, object. null in case of error. + "preimage": "0123456789abcdef..." // command-related data + } + }) + // ... +} +``` + +The `result_type` field MUST contain the name of the method that this event is responding to. +The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful. +If the command was successful, the `error` field must be null. + +### Notification Events + +The notification event is a kind 23197 event SHOULD contain one `p` tag, the public key of the **client**. + +The content of notifications is encrypted with [NIP44](44.md) (or NIP-04 for legacy client apps), and is a JSON-RPCish object with a semi-fixed structure: + +```jsonc +{ + "notification_type": "payment_received", //indicates the structure of the notification field + "notification": { + "payment_hash": "0123456789abcdef..." // notification-related data + } +} +``` + +_Note on backwards-compatibility:_ If a **wallet service** supports both nip44 and nip04 for legacy client apps, it should publish both notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. It is up to the **client** to decide which event to listen to based on its supported encryption and declared supported encryption schemes of the **wallet service** in the `info` event. + +### Error codes +- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. +- `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented. +- `INSUFFICIENT_BALANCE`: The wallet does not have enough funds to cover a fee reserve or the payment amount. +- `QUOTA_EXCEEDED`: The wallet has exceeded its spending quota. +- `RESTRICTED`: This public key is not allowed to do this operation. +- `UNAUTHORIZED`: This public key has no wallet connected. +- `INTERNAL`: An internal error. +- `UNSUPPORTED_ENCRYPTION`: The encryption type of the request is not supported by the wallet service. +- `OTHER`: Other error. + +## Nostr Wallet Connect URI + +Communication between the **client** and **wallet service** requires two keys in order to encrypt and decrypt messages. The connection URI includes the secret key of the **client** and only the public key of the **wallet service**. + +The **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. + +The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its 32-byte hex-encoded `pubkey`, which SHOULD be unique per client connection. + +The connection URI contains the following query string parameters: + +- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. +- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. The **wallet service** MUST use the corresponding public key of this secret to communicate with the **client**. + - Authorization does not require passing keys back and forth. + - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets). + - The key is harder to leak since it is not shown to the user and backed up. + - It improves privacy because the user's main key would not be linked to their payments. +- `lud16` Recommended. A lightning address that clients can use to automatically setup the `lud16` field on the user's profile if they have none configured. + +The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events, and ideally retain the events until they are either consumed or become stale. + +- When the **client** sends or receives a message it will use the `secret` from the connection URI and **wallet service**'s `pubkey` to encrypt or decrypt. +- When the **wallet service** sends or receives a message it will use its own secret and the corresponding pubkey of the **client's** `secret` to encrypt or decrypt. The **wallet service** SHOULD NOT store the secret it generates for the client and MUST NOT rely on the knowing the **client** secret for general operation. + +### Example connection string +```sh +nostr+walletconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c +``` + +## Commands + +### `pay_invoice` + +Description: Requests payment of an invoice. + +Request: +```jsonc +{ + "method": "pay_invoice", + "params": { + "invoice": "lnbc50n1...", // bolt11 invoice + "amount": 123, // invoice amount in msats, optional + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional + } +} +``` + +Response: +```jsonc +{ + "result_type": "pay_invoice", + "result": { + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `multi_pay_invoice` + +Description: Requests payment of multiple invoices. + +Request: +```jsonc +{ + "method": "multi_pay_invoice", + "params": { + "invoices": [ + {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123}, // bolt11 invoice and amount in msats, amount is optional + {"id":"3da52c32a1", "invoice": "lnbc50n1...", "metadata": {} }, // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional + ], + } +} +``` + +Response: + +For every invoice in the request, a separate response event is sent. To differentiate between the responses, each +response event contains a `d` tag with the id of the invoice it is responding to; if no id was given, then the +payment hash of the invoice should be used. + +```jsonc +{ + "result_type": "multi_pay_invoice", + "result": { + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `pay_keysend` + +Request: +```jsonc +{ + "method": "pay_keysend", + "params": { + "amount": 123, // invoice amount in msats, required + "pubkey": "03...", // payee pubkey, required + "preimage": "0123456789abcdef...", // preimage of the payment, optional + "tlv_records": [ // tlv records, optional + { + "type": 5482373484, // tlv type + "value": "0123456789abcdef" // hex encoded tlv value + } + ] + } +} +``` + +Response: +```jsonc +{ + "result_type": "pay_keysend", + "result": { + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `multi_pay_keysend` + +Description: Requests multiple keysend payments. + +Has an array of keysends, these follow the same semantics as `pay_keysend`, just done in a batch + +Request: +```jsonc +{ + "method": "multi_pay_keysend", + "params": { + "keysends": [ + {"id": "4c5b24a351", "pubkey": "03...", "amount": 123}, + {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]}, + ], + } +} +``` + +Response: + +For every keysend in the request, a separate response event is sent. To differentiate between the responses, each +response event contains a `d` tag with the id of the keysend it is responding to; if no id was given, then the +pubkey should be used. + +```jsonc +{ + "result_type": "multi_pay_keysend", + "result": { + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `make_invoice` + +Request: +```jsonc +{ + "method": "make_invoice", + "params": { + "amount": 123, // value in msats + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "expiry": 213, // expiry in seconds from time invoice is created, optional + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional + } +} +``` + +Response: +```jsonc +{ + "result_type": "make_invoice", + "result": { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "state": "pending", // optional + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage, optional if unpaid + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +### `lookup_invoice` + +Request: +```jsonc +{ + "method": "lookup_invoice", + "params": { + "payment_hash": "31afdf1..", // payment hash of the invoice, one of payment_hash or invoice is required + "invoice": "lnbc50n1..." // invoice to lookup + } +} +``` + +Response: +```jsonc +{ + "result_type": "lookup_invoice", + "result": { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage, optional if unpaid + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time, optional if unpaid + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +Errors: +- `NOT_FOUND`: The invoice could not be found by the given parameters. + +### `list_transactions` + +Lists invoices and payments. If `type` is not specified, both invoices and payments are returned. +The `from` and `until` parameters are timestamps in seconds since epoch. If `from` is not specified, it defaults to 0. +If `until` is not specified, it defaults to the current time. Transactions are returned in descending order of creation +time. + +Request: +```jsonc +{ + "method": "list_transactions", + "params": { + "from": 1693876973, // starting timestamp in seconds since epoch (inclusive), optional + "until": 1703225078, // ending timestamp in seconds since epoch (inclusive), optional + "limit": 10, // maximum number of invoices to return, optional + "offset": 0, // offset of the first invoice to return, optional + "unpaid": true, // include unpaid invoices, optional, default false + "type": "incoming", // "incoming" for invoices, "outgoing" for payments, undefined for both + } +} +``` + +Response: +```jsonc +{ + "result_type": "list_transactions", + "result": { + "transactions": [ + { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage, optional if unpaid + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time, optional if unpaid + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } + ], + }, +} +``` + +### `get_balance` + +Request: +```jsonc +{ + "method": "get_balance", + "params": {} +} +``` + +Response: +```jsonc +{ + "result_type": "get_balance", + "result": { + "balance": 10000, // user's balance in msats + } +} +``` + +### `get_info` + +Request: +```jsonc +{ + "method": "get_info", + "params": {} +} +``` + +Response: +```jsonc +{ + "result_type": "get_info", + "result": { + "alias": "string", + "color": "hex string", + "pubkey": "hex string", + "network": "string", // mainnet, testnet, signet, or regtest + "block_height": 1, + "block_hash": "hex string", + "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection + "notifications": ["payment_received", "payment_sent"], // list of supported notifications for this connection, optional. + } +} +``` + +## Notifications + +### `payment_received` + +Description: A payment was successfully received by the wallet. + +Notification: +```jsonc +{ + "notification_type": "payment_received", + "notification": { + "type": "incoming", + "state": "settled", // optional + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +### `payment_sent` + +Description: A payment was successfully sent by the wallet. + +Notification: +```jsonc +{ + "notification_type": "payment_sent", + "notification": { + "type": "outgoing", + "state": "settled", // optional + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +## Example pay invoice flow + +0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect://` deeplink or configure the connection details manually. +1. **client** sends an event to the **wallet service** with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. +2. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. +3. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. + +## Encryption + +The initial version of NWC used [NIP-04](04.md) for encryption which has been deprecated and replaced by [NIP-44](44.md). NIP-44 should always be preferred for encryption, but there may be legacy cases +where the **wallet service** or **client** has not yet migrated to NIP-44. The **wallet service** and **client** should negotiate the encryption method to use based on the `encryption` tag in the `info` event. + +The encryption tag can contain either `nip44_v2` or `nip04`. The absence of this tag implies that the wallet only supports `nip04`. + +| Encryption code | Use | Notes | +|-----------------|----------------------|---------------------------------------------------------| +| `nip44_v2` | NIP-44 | Required | +| `nip04` | NIP-04 | Deprecated and only here for backward compatibility | +| `<not present>` | NIP-04 | Deprecated and only here for backward compatibility | + +The negotiation works as follows. + +1. The **wallet service** includes an `encryption` tag in the `info` event. This tag contains a space-separated list of encryption schemes that the **wallet service** supports (eg. `nip44_v2 nip04`) +2. The **client application** includes an `encryption` tag in each request event. This tag contains the encryption scheme which should be used for the request. The **client application** should always prefer nip44 if supported by the **wallet service**. + +### Info event + +First, the **wallet service** adds an `encryption` tag to its `info` event containing a space-separated list of encryption schemes it supports. For example, +if a wallet service supports nip44, but also allows backwards-compatibility to nip04 client applications, its `encryption` tag in the `info` event might look something like: + +```jsonc +{ + "kind": 13194, + "tags": [ + ["encryption", "nip44_v2 nip04"], + // ... + ], + "content": "pay_invoice get_balance make_invoice lookup_invoice list_transactions get_info", + // ... +} +``` + +When a **client application** establishes a connection, it should read the info event and look for the `encryption` tag. + +**Absence of this tag implies that the wallet only supports nip04.** + +If the `encryption` tag is present, the **client application** will choose optimal encryption supported by both itself, and the **wallet service**, which should always be nip44 if possible. + +### Request events + +When a **client application** sends a request event, it should include a `encryption` tag with the encryption scheme it is using. The scheme MUST be supported by the **wallet service** as indicated by the info event. +For example, if the client application supports nip44, the request event might look like: + +```jsonc +{ + "kind": 23194, + "tags": [ + ["encryption", "nip44_v2"], + // ... + ], + // ... +} +``` + +If the **wallet service** does not support the specified encryption scheme, it will return an `UNSUPPORTED_ENCRYPTION` error. Absence of the `encryption` tag indicates use of nip04 for encryption. + +### Notification events + +As described above in the [Notifications](#notifications) section, if a **wallet service** supports both nip04 and nip44, it should publish two notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. If the **wallet service** only supports nip44, it should only publish kind 23197 events. + +The **client** should check the `encryption` tag in the `info` event to determine which encryption schemes the **wallet service** supports, and listen to the appropriate notification event. + +## Using a dedicated relay +This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. + +## Metadata +Metadata MAY be stored by the **wallet service** alongside invoices and payments. The metadata MUST be no more than 4096 characters, otherwise MUST be dropped. This is to ensure transactions do not get too large to be relayed. + +NWC relays SHOULD allow at least a payload size of 64KB and **clients** SHOULD fetch small page sizes (maximum of 20 transactions per page) otherwise there is risk of `list_transactions` responses being rejected. + +Here are some properties that are recognized by some NWC clients: + +```jsonc +{ + "comment": "string", // LUD-12 comment + "payer_data": { + "email": "string", + "name": "string", + "pubkey": "string", + }, // LUD-18 payer data + "recipient_data": { + "identifier": "string" + }, // similar to LUD-18 payer data, but to record recipient data e.g. the lightning address of the recipient + "nostr": { + "pubkey": "string", + "tags": [], + // ... rest of zap request event + }, // NIP-57 Zap Request event (kind 9734) + "tlv_records": [ + { + "type": 5482373484, // tlv type + "value": "0123456789abcdef" // hex encoded tlv value + } + ] // keysend TLV records (e.g. for podcasting 2.0 boostagrams) +} & Record<string, unknown>; +``` + +## Appendix + +### Example NIP-47 info event + +```jsonc +{ + "id": "df467db0a9f9ec77ffe6f561811714ccaa2e26051c20f58f33c3d66d6c2b4d1c", + "pubkey": "c04ccd5c82fc1ea3499b9c6a5c0a7ab627fbe00a0116110d4c750faeaecba1e2", + "created_at": 1713883677, + "kind": 13194, + "tags": [ + [ "encryption", "nip44_v2 nip04" ], + [ + "notifications", + "payment_received payment_sent" + ] + ], + "content": "pay_invoice pay_keysend get_balance get_info make_invoice lookup_invoice list_transactions multi_pay_invoice multi_pay_keysend sign_message notifications", + "sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8" +} +``` + +### Deep-links + +Wallet applications can register deeplinks in mobile systems to make it possible to create a linking UX that doesn't require the user scanning a QR code or pasting some code. + +`nostrnwc://connect` and `nostrnwc+{app_name}://connect` can be registered by wallet apps and queried by apps that want to receive an NWC pairing code. + +All URI parameters, MUST be URI-encoded. + +URI parameters: + * `appicon` -- URL to an icon of the client that wants to create a connection. + * `appname` -- Name of the client that wants to create a connection. + * `callback` -- URI schema the wallet should open with the connection string + +Once a connection has been created by the wallet, it should be returned to the client by opening the callback with the following parameters + * `value` -- NWC pairing code (e.g. `nostr+walletconnect://...`) + + diff --git a/docs/nips/48.md b/docs/nips/48.md new file mode 100644 index 00000000..2f03e002 --- /dev/null +++ b/docs/nips/48.md @@ -0,0 +1,60 @@ +NIP-48 +====== + +Proxy Tags +---------- + +`draft` `optional` + +Nostr events bridged from other protocols such as ActivityPub can link back to the source object by including a `"proxy"` tag, in the form: + +``` +["proxy", <id>, <protocol>] +``` + +Where: + +- `<id>` is the ID of the source object. The ID format varies depending on the protocol. The ID must be universally unique, regardless of the protocol. +- `<protocol>` is the name of the protocol, e.g. `"activitypub"`. + +Clients may use this information to reconcile duplicated content bridged from other protocols, or to display a link to the source object. + +Proxy tags may be added to any event kind, and doing so indicates that the event did not originate on the Nostr protocol, and instead originated elsewhere on the web. + +### Supported protocols + +This list may be extended in the future. + +| Protocol | ID format | Example | +| -------- | --------- | ------- | +| `activitypub` | URL | `https://gleasonator.com/objects/9f524868-c1a0-4ee7-ad51-aaa23d68b526` | +| `atproto` | AT URI | `at://did:plc:zhbjlbmir5dganqhueg7y4i3/app.bsky.feed.post/3jt5hlibeol2i` | +| `rss` | URL with guid fragment | `https://soapbox.pub/rss/feed.xml#https%3A%2F%2Fsoapbox.pub%2Fblog%2Fmostr-fediverse-nostr-bridge` | +| `web` | URL | `https://twitter.com/jack/status/20` | + +### Examples + +ActivityPub object: + +```json +{ + "kind": 1, + "content": "I'm vegan btw", + "tags": [ + [ + "proxy", + "https://gleasonator.com/objects/8f6fac53-4f66-4c6e-ac7d-92e5e78c3e79", + "activitypub" + ] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1691091365, + "id": "55920b758b9c7b17854b6e3d44e6a02a83d1cb49e1227e75a30426dea94d4cb2", + "sig": "a72f12c08f18e85d98fb92ae89e2fe63e48b8864c5e10fbdd5335f3c9f936397a6b0a7350efe251f8168b1601d7012d4a6d0ee6eec958067cf22a14f5a5ea579" +} +``` + +### See also + +- [FEP-fffd: Proxy Objects](https://codeberg.org/fediverse/fep/src/branch/main/fep/fffd/fep-fffd.md) +- [Mostr bridge](https://mostr.pub/) \ No newline at end of file diff --git a/docs/nips/49.md b/docs/nips/49.md new file mode 100644 index 00000000..731f132d --- /dev/null +++ b/docs/nips/49.md @@ -0,0 +1,126 @@ + +NIP-49 +====== + +Private Key Encryption +---------------------- + +`draft` `optional` + +This NIP defines a method by which clients can encrypt (and decrypt) a user's private key with a password. + +Symmetric Encryption Key derivation +----------------------------------- + +PASSWORD = Read from the user. The password should be unicode normalized to NFKC format to ensure that the password can be entered identically on other computers/clients. + +LOG\_N = Let the user or implementer choose one byte representing a power of 2 (e.g. 18 represents 262,144) which is used as the number of rounds for scrypt. Larger numbers take more time and more memory, and offer better protection: + + | LOG_N | MEMORY REQUIRED | APPROX TIME ON FAST COMPUTER | + |-------|-----------------|----------------------------- | + | 16 | 64 MiB | 100 ms | + | 18 | 256 MiB | | + | 20 | 1 GiB | 2 seconds | + | 21 | 2 GiB | | + | 22 | 4 GiB | | + +SALT = 16 random bytes + +SYMMETRIC_KEY = scrypt(password=PASSWORD, salt=SALT, log\_n=LOG\_N, r=8, p=1) + +The symmetric key should be 32 bytes long. + +This symmetric encryption key is temporary and should be zeroed and discarded after use and not stored or reused for any other purpose. + + +Encrypting a private key +------------------------ + +The private key encryption process is as follows: + +PRIVATE\_KEY = User's private (secret) secp256k1 key as 32 raw bytes (not hex or bech32 encoded!) + +KEY\_SECURITY\_BYTE = one of: + +* 0x00 - if the key has been known to have been handled insecurely (stored unencrypted, cut and paste unencrypted, etc) +* 0x01 - if the key has NOT been known to have been handled insecurely (stored unencrypted, cut and paste unencrypted, etc) + * 0x02 - if the client does not track this data + +ASSOCIATED\_DATA = KEY\_SECURITY\_BYTE + +NONCE = 24 byte random nonce + +CIPHERTEXT = XChaCha20-Poly1305( + plaintext=PRIVATE\_KEY, + associated_data=ASSOCIATED\_DATA, + nonce=NONCE, + key=SYMMETRIC\_KEY +) + +VERSION\_NUMBER = 0x02 + +CIPHERTEXT_CONCATENATION = concat( + VERSION\_NUMBER, + LOG\_N, + SALT, + NONCE, + ASSOCIATED\_DATA, + CIPHERTEXT +) + +ENCRYPTED\_PRIVATE\_KEY = bech32_encode('ncryptsec', CIPHERTEXT\_CONCATENATION) + +The output prior to bech32 encoding should be 91 bytes long. + +The decryption process operates in the reverse. + + +Test Data +--------- + +## Password Unicode Normalization + +The following password input: "ÅΩẛ̣" +- Unicode Codepoints: U+212B U+2126 U+1E9B U+0323 +- UTF-8 bytes: [0xE2, 0x84, 0xAB, 0xE2, 0x84, 0xA6, 0xE1, 0xBA, 0x9B, 0xCC, 0xA3] + +Should be converted into the unicode normalized NFKC format prior to use in scrypt: "ÅΩẛ̣" +- Unicode Codepoints: U+00C5 U+03A9 U+1E69 +- UTF-8 bytes: [0xC3, 0x85, 0xCE, 0xA9, 0xE1, 0xB9, 0xA9] + +## Encryption + +The encryption process is non-deterministic due to the random nonce. + +## Decryption + +The following encrypted private key: + +`ncryptsec1qgg9947rlpvqu76pj5ecreduf9jxhselq2nae2kghhvd5g7dgjtcxfqtd67p9m0w57lspw8gsq6yphnm8623nsl8xn9j4jdzz84zm3frztj3z7s35vpzmqf6ksu8r89qk5z2zxfmu5gv8th8wclt0h4p` + +When decrypted with password='nostr' and log_n=16 yields the following hex-encoded private key: + +`3501454135014541350145413501453fefb02227e449e57cf4d3a3ce05378683` + +Discussion +---------- + +### On Key Derivation + +Passwords make poor cryptographic keys. Prior to use as a cryptographic key, two things need to happen: + +1. An encryption key needs to be deterministically created from the password such that is has a uniform functionally random distribution of bits, such that the symmetric encryption algorithm's assumptions are valid, and +2. A slow irreversible algorithm should be injected into the process, so that brute-force attempts to decrypt by trying many passwords are severely hampered. + +These are achieved using a password-based key derivation function. We use scrypt, which has been proven to be maximally memory hard and which several cryptographers have indicated to the author is better than argon2 even though argon2 won a competition in 2015. + +### On the symmetric encryption algorithm + +XChaCha20-Poly1305 is typically favored by cryptographers over AES and is less associated with the U.S. government. It (or it's earlier variant without the 'X') is gaining wide usage, is used in TLS and OpenSSH, and is available in most modern crypto libraries. + +Recommendations +--------- + +It is not recommended that users publish these encrypted private keys to nostr, as cracking a key may become easier when an attacker can amass many encrypted private keys. + +It is recommended that clients zero out the memory of passwords and private keys before freeing that memory. diff --git a/docs/nips/50.md b/docs/nips/50.md new file mode 100644 index 00000000..9eea1f85 --- /dev/null +++ b/docs/nips/50.md @@ -0,0 +1,55 @@ +NIP-50 +====== + +Search Capability +----------------- + +`draft` `optional` + +## Abstract + +Many Nostr use cases require some form of general search feature, in addition to structured queries by tags or ids. +Specifics of the search algorithms will differ between event kinds, this NIP only describes a general +extensible framework for performing such queries. + +## `search` filter field + +A new `search` field is introduced for `REQ` messages from clients: +```jsonc +{ + // other fields on filter object... + "search": <string> +} +``` +`search` field is a string describing a query in a human-readable form, i.e. "best nostr apps". +Relays SHOULD interpret the query to the best of their ability and return events that match it. +Relays SHOULD perform matching against `content` event field, and MAY perform +matching against other fields if that makes sense in the context of a specific kind. + +Results SHOULD be returned in descending order by quality of search result (as defined by the implementation), +not by the usual `.created_at`. The `limit` filter SHOULD be applied after sorting by matching score. +A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore +extensions they don't support. + +Clients may specify several search filters, i.e. `["REQ", "", { "search": "orange" }, { "kinds": [1, 2], "search": "purple" }]`. Clients may +include `kinds`, `ids` and other filter field to restrict the search results to particular event kinds. + +Clients SHOULD use the supported_nips field to learn if a relay supports `search` filter. Clients MAY send `search` +filter queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP. + +Clients SHOULD query several relays supporting this NIP to compensate for potentially different +implementation details between relays. + +Clients MAY verify that events returned by a relay match the specified query in a way that suits the +client's use case, and MAY stop querying relays that have low precision. + +Relays SHOULD exclude spam from search results by default if they support some form of spam filtering. + +## Extensions + +Relay MAY support these extensions: +- `include:spam` - turn off spam filtering, if it was enabled by default +- `domain:<domain>` - include only events from users whose valid nip05 domain matches the domain +- `language:<two letter ISO 639-1 language code>` - include only events of a specified language +- `sentiment:<negative/neutral/positive>` - include only events of a specific sentiment +- `nsfw:<true/false>` - include or exclude nsfw events (default: true) diff --git a/docs/nips/51.md b/docs/nips/51.md new file mode 100644 index 00000000..a7a16288 --- /dev/null +++ b/docs/nips/51.md @@ -0,0 +1,170 @@ +NIP-51 +====== + +Lists +----- + +`draft` `optional` + +This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**. + +Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-44](44.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. An earlier version of this specification used [NIP-04](04.md) for encryptions. Those are now deprecated. For backward compatibility, Clients can automatically discover if the encryption is NIP-04 or NIP-44 by searching for "iv" in the ciphertext and decrypting accordingly. + +When new items are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order. + +## Types of lists + +### Standard lists + +Standard lists use normal replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience. + +For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. + +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Follow list | 3 | microblogging basic follow list, see [NIP-02](02.md) | `"p"` (pubkeys -- with optional relay hint and petname) | +| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | +| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Read/write relays | 10002 | where a user publishes to and where they expect mentions | see [NIP-65](65.md) | +| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | +| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | +| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | +| Relay feeds | 10012 | user favorite browsable relays (and relay sets) | `"relay"` (relay URLs) and `"a"` (kind:30002 relay set) | +| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | +| Media follows | 10020 | multimedia (photos, short video) follow list | `"p"` (pubkeys -- with optional relay hint and petname) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | +| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | +| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | + +### Sets + +Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of them must be assigned a different `"d"` identifier. + +For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ can be used by apps to showcase curations made by others tagged to different topics. + +Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tags that can be used to enhance their UI. + +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | +| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"e"` (kind:21 videos) | +| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | +| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | +| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | +| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | +| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | +| Calendar | 31924 | a set of events categorized in any way | `"a"` (calendar event event) | +| Starter packs | 39089 | a named set of profiles to be shared around with the goal of being followed together | `"p"` (pubkeys) | +| Media starter packs | 39092 | same as above, but specific to multimedia (photos, short video) clients | `"p"` (pubkeys) | + +### Deprecated standard lists + +Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. + +| kind | "d" tag | use instead | +| --- | --- | --- | +| 30000 | `"mute"` | kind 10000 _mute list_ | +| 30001 | `"pin"` | kind 10001 _pin list_ | +| 30001 | `"bookmark"` | kind 10003 _bookmarks list_ | +| 30001 | `"communities"` | kind 10004 _communities list_ | + +## Examples + +### A _mute list_ with some public items and some encrypted items + +```json +{ + "id": "a92a316b75e44cfdc19986c634049158d4206fcc0b7b9c7ccbcdabe28beebcd0", + "pubkey": "854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb", + "created_at": 1699597889, + "kind": 10000, + "tags": [ + ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"], + ["p", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"] + ], + "content": "TJob1dQrf2ndsmdbeGU+05HT5GMnBSx3fx8QdDY/g3NvCa7klfzgaQCmRZuo1d3WQjHDOjzSY1+MgTK5WjewFFumCcOZniWtOMSga9tJk1ky00tLoUUzyLnb1v9x95h/iT/KpkICJyAwUZ+LoJBUzLrK52wNTMt8M5jSLvCkRx8C0BmEwA/00pjOp4eRndy19H4WUUehhjfV2/VV/k4hMAjJ7Bb5Hp9xdmzmCLX9+64+MyeIQQjQAHPj8dkSsRahP7KS3MgMpjaF8nL48Bg5suZMxJayXGVp3BLtgRZx5z5nOk9xyrYk+71e2tnP9IDvSMkiSe76BcMct+m7kGVrRcavDI4n62goNNh25IpghT+a1OjjkpXt9me5wmaL7fxffV1pchdm+A7KJKIUU3kLC7QbUifF22EucRA9xiEyxETusNludBXN24O3llTbOy4vYFsq35BeZl4v1Cse7n2htZicVkItMz3wjzj1q1I1VqbnorNXFgllkRZn4/YXfTG/RMnoK/bDogRapOV+XToZ+IvsN0BqwKSUDx+ydKpci6htDRF2WDRkU+VQMqwM0CoLzy2H6A2cqyMMMD9SLRRzBg==?iv=S3rFeFr1gsYqmQA7bNnNTQ==", + "sig": "1173822c53261f8cffe7efbf43ba4a97a9198b3e402c2a1df130f42a8985a2d0d3430f4de350db184141e45ca844ab4e5364ea80f11d720e36357e1853dba6ca" +} +``` + +### A _curation set_ of articles and notes about yaks + +```json +{ + "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", + "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", + "created_at": 1695327657, + "kind": 30004, + "tags": [ + ["d", "jvdy9i4"], + ["title", "Yaks"], + ["image", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"], + ["description", "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia."], + ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], + ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], + ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], + ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"] + ], + "content": "", + "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd" +} +``` + +### A _release artifact set_ of an Example App + +```jsonc +{ + "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", + "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", + "created_at": 1695327657, + "kind": 30063, + "content": "Release notes in markdown", + "tags": [ + ["d", "com.example.app@0.0.1"], + ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"], // Windows exe + ["e", "f27e2c91051de0c4e1da0d5dce22bfff9db0a9340e0326b4941ed78bae996c9e"], // MacOS dmg + ["e", "9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad02332"], // Linux AppImage + ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"], // PWA + ["a", "32267:d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:com.example.app"] // Reference to parent software application + ], + "content": "Example App is a decentralized marketplace for apps", + "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd" +} +``` + +### An _app curation set_ + +```jsonc +{ + "id": "d8037fa866eb5acd2159960b3ada7284172f7d687b5289cc72a96ca2b431b611", + "pubkey": "78ce6faa72264387284e647ba6938995735ec8c7d5c5a65737e55130f026307d", + "sig": "c1ce0a04521c020ae7485307cd86285530c1f778766a3fd594d662a73e7c28f307d7cd9a9ab642ae749fce62abbabb3a32facfe8d19a21fba551b60fae863d95", + "kind": 30267, + "created_at": 1729302793, + "content": "My nostr app selection", + "tags": [ + ["d", "nostr"], + ["a", "32267:7579076d9aff0a4cfdefa7e2045f2486c7e5d8bc63bfc6b45397233e1bbfcb19:com.example.app1"], + ["a", "32267:045f2486c7e5d8bc63bfc6b45397233e1bbfcb197579076d9aff0a4cfdefa7e2:net.example.app2"], + ["a", "32267:264387284e647ba6938995735ec8c7d5c5a6f026307d78ce6faa725737e55130:pl.code.app3"] + ] +} +``` + +## Encryption process pseudocode + +```scala +val private_items = [ + ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"], + ["a", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"], +] +val base64blob = nip44.encrypt(json.encode_to_string(private_items)) +event.content = base64blob +``` diff --git a/docs/nips/52.md b/docs/nips/52.md new file mode 100644 index 00000000..133e3b36 --- /dev/null +++ b/docs/nips/52.md @@ -0,0 +1,216 @@ +NIP-52 +====== + +Calendar Events +--------------- + +`draft` `optional` + +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _addressable_ and deletable per [NIP-09](09.md). + +Unlike the term `calendar event` specific to this NIP, the term `event` is used broadly in all the NIPs to describe any Nostr event. The distinction is being made here to discern between the two terms. + +## Calendar Events + +There are two types of calendar events represented by different kinds: _date-based_ and _time-based_ calendar events. + +These tags are common to both types of calendar events: + +* `d` (required) a short unique string identifier. Generated by the client creating the calendar event. +* `title` (required) title of the calendar event +* `summary` (optional) brief description of the calendar event +* `image` (optional) url of an image to use for the event +* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. +* `a` (repeated) reference tag to kind `31924` calendar event requesting to be included in Calendar + +The following tags are deprecated: + +* `name` name of the calendar event. Use only if `title` is not available. + +Calendar events are _not_ required to be part of a [calendar](#calendar). + +## Collaborative Calendar Event Requests + +Calendar events can include an `a` tag referencing a calendar (kind 31924) to request addition to that calendar. When a calendar event includes such a reference, clients should interpret this as a request to add the event to the referenced calendar by referencing it with an `a` tag. + +This enables collaborative calendar management where multiple users can contribute events to calendars they do not own, subject to the calendar owner's approval. + +### Date-Based Calendar Event + +This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. + +It's an _addressable event_ of `kind:31922`. + +The `.content` of these events SHOULD be a description of the calendar event. + +Aside from the common tags, this also takes the following tags: + +* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. +* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. + +Example: + +```yaml +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <unix timestamp in seconds>, + "kind": 31922, + "content": "<description of calendar event>", + "tags": [ + ["d", "<random-identifier>"], + + ["title", "<title of calendar event>"], + + // dates + ["start", "<YYYY-MM-DD>"], + ["end", "<YYYY-MM-DD>"], + + // location + ["location", "<location>"], + ["g", "<geohash>"], + + // participants + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], + ] +} +``` + +### Time-Based Calendar Event + +This kind of calendar event spans between a start time and end time. + +It's an _addressable event_ of `kind:31923`. + +The `.content` of these events should be a description of the calendar event. It is required but can be an empty string. + +Aside from the common tags, this also takes the following tags: + +* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. +* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. +* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` +* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. + +```yaml +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <unix timestamp in seconds>, + "kind": 31923, + "content": "<description of calendar event>", + "tags": [ + ["d", "<random-identifier>"], + + ["title", "<title of calendar event>"], + ["summary", "<brief description of the calendar event>"], + ["image", "<string with image URI>"], + + // timestamps + ["start", "<unix timestamp in seconds>"], + ["end", "<unix timestamp in seconds>"], + + ["start_tzid", "<IANA Time Zone Database identifier>"], + ["end_tzid", "<IANA Time Zone Database identifier>"], + + // location + ["location", "<location>"], + ["g", "<geohash>"], + + // participants + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], + ] +} +``` + +## Calendar + +A calendar is a collection of calendar events, represented as a custom _addressable list_ event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. + +Calendars can accept event requests from other users. When calendar events reference a calendar via an `a` tag, this represents a request for inclusion. + +The `.content` of these events should be a detailed description of the calendar. It is required but can be an empty string. + +* `d` (required) universally unique identifier. Generated by the client creating the calendar. +* `title` (required) calendar title +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to + +```yaml +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <unix timestamp in seconds>, + "kind": 31924, + "content": "<description of calendar>", + "tags": [ + ["d", "<random-identifier>"], + ["title", "<calendar title>"], + ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], + ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"] + ] +} +``` + +## Calendar Event RSVP + +A calendar event RSVP is a response to a calendar event to indicate a user's attendance intention. + +If a calendar event tags a pubkey, that can be interpreted as the calendar event creator inviting that user to attend. Clients MAY choose to prompt the user to RSVP for the calendar event. + +Any user may RSVP, even if they were not tagged on the calendar event. Clients MAY choose to prompt the calendar event creator to invite the user who RSVP'd. Clients also MAY choose to ignore these RSVPs. + +This NIP is intentionally not defining who is authorized to attend a calendar event if the user who RSVP'd has not been tagged. It is up to the calendar event creator to determine the semantics. + +This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. + +The RSVP MUST have an `a` tag of the event coordinates to the calendar event, and optionally an `e` tag of the id of the specific calendar event revision. If an `e` tag is present, clients SHOULD interpret it as an indication that the RSVP is a response to that revision of the calendar event, and MAY interpret it to not necessarily apply to other revisions of the calendar event. + +The RSVP MAY tag the author of the calendar event it is in response to using a `p` tag so that clients can easily query all RSVPs that pertain to the author. + +The RSVP is an _addressable event_ of `kind:31925`. + +The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. + +The list of tags is as follows: + +* `a` (required) coordinates to a kind `31922` or `31923` calendar event being responded to. +* `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to. +* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. +* `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event. +* `fb` (optional) `free` or `busy`. Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. +* `p` (optional) pubkey of the author of the calendar event being responded to. + +```yaml +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <unix timestamp in seconds>, + "kind": 31925, + "content": "<note>", + "tags": [ + ["e", "<kind 31922 or 31923 event id", "<optional recommended relay URL>"] + ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional recommended relay URL>"], + ["d", "<random-identifier>"], + ["status", "<accepted/declined/tentative>"], + ["fb", "<free/busy>"], + ["p", "<hex pubkey of kind 31922 or 31923 event>", "<optional recommended relay URL>"] + ] +} +``` + +## Unsolved Limitations + +* No private events + +## Intentionally Unsupported Scenarios + +### Recurring Calendar Events + +Recurring calendar events come with a lot of complexity, making it difficult for software and humans to deal with. This complexity includes time zone differences between invitees, daylight savings, leap years, multiple calendar systems, one-off changes in schedule or other metadata, etc. + +This NIP intentionally omits support for recurring calendar events and pushes that complexity up to clients to manually implement if they desire. i.e., individual calendar events with duplicated metadata represent recurring calendar events. diff --git a/docs/nips/53.md b/docs/nips/53.md new file mode 100644 index 00000000..a0270e51 --- /dev/null +++ b/docs/nips/53.md @@ -0,0 +1,267 @@ +NIP-53 +====== + +Live Activities +--------------- + +`draft` `optional` + +This NIP introduces event kinds to advertise live spaces and the participation of pubkeys in them. + +## Live Streaming + +A special event with `kind:30311` "Live Streaming Event" is defined as an _addressable event_ whose tags advertise the content and participants of a live stream. + +Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. + +For example: + +```jsonc +{ + "kind": 30311, + "tags": [ + ["d", "<unique identifier>"], + ["title", "<name of the event>"], + ["summary", "<description>"], + ["image", "<preview image url>"], + ["t", "hashtag"] + ["streaming", "<url>"], + ["recording", "<url>"], // used to place the edited video once the activity is over + ["starts", "<unix timestamp in seconds>"], + ["ends", "<unix timestamp in seconds>"], + ["status", "<planned, live, ended>"], + ["current_participants", "<number>"], + ["total_participants", "<number>"], + ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"], + ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], + ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], + ["relays", "wss://one.com", "wss://two.com", /*...*/], + ["pinned", "<event id of pinned live chat message>"], + ], + "content": "", + // other fields... +} +``` + +A distinct `d` tag should be used for each activity. All other tags are optional. + +Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). + +Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. + +Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` + +The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. + +### Proof of Agreement to Participate + +Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex. + +Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. + +This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. + +### Live Chat Message + +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity. An `e` tag denotes the direct parent message this post is replying to. + +```jsonc +{ + "kind": 1311, + "tags": [ + ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>"], + ], + "content": "Zaps to live streams is beautiful.", + // other fields... +} +``` + +`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). + +```json +["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"] +``` + +Hosts may choose to pin one or more live chat messages by updating the `pinned` tags in the live event kind `30311`. + +### Examples + +#### Live Streaming + +```json +{ + "id": "57f28dbc264990e2c61e80a883862f7c114019804208b14da0bff81371e484d2", + "pubkey": "1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec", + "created_at": 1687182672, + "kind": 30311, + "tags": [ + ["d", "demo-cf-stream"], + ["title", "Adult Swim Metalocalypse"], + ["summary", "Live stream from IPTV-ORG collection"], + ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], + ["starts", "1687182672"], + ["status", "live"], + ["t", "animation"], + ["t", "iptv"], + ["image", "https://i.imgur.com/CaKq6Mt.png"] + ], + "content": "", + "sig": "5bc7a60f5688effa5287244a24768cbe0dcd854436090abc3bef172f7f5db1410af4277508dbafc4f70a754a891c90ce3b966a7bc47e7c1eb71ff57640f3d389" +} +``` + +#### Live Streaming chat message + +```json +{ + "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "created_at": 1687286726, + "kind": 1311, + "tags": [ + ["a", "30311:1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec:demo-cf-stream", "", "root"] + ], + "content": "Zaps to live streams is beautiful.", + "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" +} +``` + +## Meeting Spaces + +Meeting spaces contain one or more video/audio rooms where users can join and participate in the streaming. + +### Meeting Space Event (kind:30312) + +A special event with `kind:30312` "Space Host" defines the configuration and properties of a virtual interactive space. Each space has a unique identifier and can host multiple events/meetings. + +```jsonc +{ + "kind": 30312, + "tags": [ + ["d", "<unique identifier>"], // Required: Room identifier + ["room", "<name of the room>"], // Required: Display name + ["summary", "<description>"], // Optional: Room description + ["image", "<preview image url>"], // Optional: Room image + ["status", "<open, private, closed>"], // Required: Room accessibility + ["service", "<url>"], // Required: URL to access the room + ["endpoint", "<url>"], // Optional: API endpoint for status/info + ["t", "<hashtag>"], // Optional: Multiple hashtags allowed + ["p", "<pubkey>", "<url>", "<role>", "<proof>"], // Required: At least one provider + ["relays", "<url>", "<url>", /*...*/] // Optional: Preferred relays + ], + "content": "" // Usually empty, may contain additional metadata +} +``` + +Space properties: +* MUST be either open, private or closed. Closed means the room is not in operation. +* MAY specify access control policy for private rooms (e.g. invite-only, payment required) +* MAY persist when not in use +* MUST have at least one provider with "Host" role +* MAY have multiple providers with different roles + +Provider roles (p tags): +* Host: Full room management capabilities +* Moderator: Room moderation capabilities +* Speaker: Allowed to present/speak +* Optional proof field for role verification + +### Meeting Room Events (kind:30313) + +A special event with kind:30313 represents a scheduled or ongoing meeting within a room. It MUST reference its parent room using the d tag. + +```jsonc +{ + "kind": 30313, + "tags": [ + ["d", "<event-unique-identifier>"], // Required: Event identifier + ["a", "30312:<pubkey>:<room-id>", "wss://nostr.example.com"], // Required: Reference to parent space, 'd' from 30312 + ["title", "<meeting-title>"], // Required: Meeting title + ["summary", "<description>"], // Optional: Meeting description + ["image", "<preview image url>"], // Optional: Meeting image + ["starts", "<unix timestamp>"], // Required: Start time + ["ends", "<unix timestamp>"], // Optional: End time + ["status", "<planned, live, ended>"], // Required: Meeting status + ["total_participants", "<number>"], // Optional: Total registered + ["current_participants", "<number>"], // Optional: Currently active + ["p", "<pubkey>", "<url>", "<role>"], // Optional: Participant with role + ], + "content": "" // Usually empty, may contain additional metadata +} +``` + +Event properties: +* MUST reference parent room via d tag +* MUST have a status (planned/live/ended) +* MUST have a start time +* MAY track participant counts +* MAY include participant roles specific to the event + +Event management: +* Clients SHOULD update event status regularly when live +* Events without updates for 1 hour MAY be considered ended +* starts and ends timestamps SHOULD be updated when status changes + +### Examples + +#### Meeting Space (kind:30312) + +```jsonc +{ + "kind": 30312, + "tags": [ + ["d", "main-conference-room"], + ["room", "Main Conference Hall"], + ["summary", "Our primary conference space"], + ["image", "https://example.com/room.jpg"], + ["status", "open"], + ["service", "https://meet.example.com/room"], + ["endpoint", "https://api.example.com/room"], + ["t", "conference"], + ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca", "wss://nostr.example.com/", "Owner"], + ["p", "14aeb..8dad4", "wss://provider2.com/", "Moderator"], + ["relays", "wss://relay1.com", "wss://relay2.com"] + ], + "content": "" +} +``` + +#### Meeting room (kind:30313) + +```jsonc +{ + "kind": 30313, + "tags": [ + ["d", "annual-meeting-2025"], + ["a", "30312:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:main-conference-room", "wss://nostr.example.com"] + ["title", "Annual Company Meeting 2025"], + ["summary", "Yearly company-wide meeting"], + ["image", "https://example.com/meeting.jpg"], + ["starts", "1676262123"], + ["ends", "1676269323"], + ["status", "live"], + ["total_participants", "180"], + ["current_participants", "175"], + ["p", "91cf9..4e5ca", "wss://provider1.com/", "Speaker"], + ], + "content": "" +} +``` +### Room Presence + +New `kind: 10312` provides an event which signals presence of a listener. + +The presence event SHOULD be updated at regular intervals and clients SHOULD filter presence events older than +a given time window. + +**This kind `10312` is a regular replaceable event, as such presence can only be indicated in one room at a time.** + +```json +{ + "kind": 10312, + "tags": [ + ["a" , "<room-a-tag>", "<relay-hint>", "root"], + ["hand", "1"] // hand raised flag + ] +} +``` diff --git a/docs/nips/54.md b/docs/nips/54.md new file mode 100644 index 00000000..b23e8bd9 --- /dev/null +++ b/docs/nips/54.md @@ -0,0 +1,117 @@ +NIP-54 +====== + +Wiki +---- + +`draft` `optional` + +This NIP defines `kind:30818` (an _addressable event_) for descriptions (or encyclopedia entries) of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. + +Articles are identified by lowercase, normalized ascii `d` tags. + +## Articles +```json +{ + "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", + "tags": [ + ["d", "wiki"], + ["title", "Wiki"], + ] +} +``` + +## `d` tag normalization rules + +- Any non-letter character MUST be converted to a `-`. +- All letters MUST be converted to lowercase. + +## Content + +The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links. + +Unlike normal Asciidoc links `http://example.com[]` that link to external webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink. + +Wikilinks can take these two forms: + + 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`; + 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. + +`nostr:...` links, as per [NIP-21](21.md), should link to profiles or arbitrary Nostr events. Although it is not recommended to link to specific versions of articles -- instead the _wikilink_ syntax should be preferred, since it should be left to the reader and their client to decide what version of any given article they want to read. + +## Optional extra tags + + - `title`: for when the display title should be different from the `d` tag. + - `summary`: for display in lists. + - `a` and `e`: for referencing the original event a wiki article was forked from. + +## Merge Requests + +Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event. + +[INSERT EVENT EXAMPLE] + +## Redirects + +Event `kind:30819` is also defined to stand for "wiki redirects", i.e. if one thinks `Shell structure` should redirect to `Thin-shell structure` they can issue one of these events instead of replicating the content. These events can be used for automatically redirecting between articles on a client, but also for generating crowdsourced "disambiguation" pages ([common in Wikipedia](https://en.wikipedia.org/wiki/Help:Disambiguation)). + +[INSERT EVENT EXAMPLE] + +## How to decide what article to display + +As there could be many articles for each given name, some kind of prioritization must be done by clients. Criteria for this should vary between users and clients, but some means that can be used are described below: + +### Reactions + +[NIP-25](25.md) reactions are very simple and can be used to create a simple web-of-trust between wiki article writers and their content. While just counting a raw number of "likes" is unproductive, reacting to any wiki article event with a `+` can be interpreted as a recommendation for that article specifically and a partial recommendation of the author of that article. When 2 or 3-level deep recommendations are followed, suddenly a big part of all the articles may have some form of tagging. + +### Relays + +[NIP-51](51.md) lists of relays can be created with the kind 10102 and then used by wiki clients in order to determine where to query articles first and to rank these differently in relation to other events fetched from other relays. + +### Contact lists + +[NIP-02](02.md) contact lists can form the basis of a recommendation system that is then expanded with relay lists and reaction lists through nested queries. These lists form a good starting point only because they are so widespread. + +### Wiki-related contact lists + +[NIP-51](51.md) lists can also be used to create a list of users that are trusted only in the context of wiki authorship or wiki curationship. + +## Forks +Wiki-events can tag other wiki-events with a `fork` marker to specify that this event came from a different version. Both `a` and `e` tags SHOULD be used and have the `fork` marker applied, to identify the exact version it was forked from. + +## Deference +Wiki-events can tag other wiki-events with a `defer` marker to indicate that it considers someone else's entry as a "better" version of itself. If using a `defer` marker both `a` and `e` tags SHOULD be used. + +This is a stronger signal of trust than a `+` reaction. + +This marker is useful when a user edits someone else's entry; if the original author includes the editor's changes and the editor doesn't want to keep/maintain an independent version, the `link` tag could effectively be a considered a "deletion" of the editor's version and putting that pubkey's WoT weight behind the original author's version. + +## Why Asciidoc? + +Wikitext is [garbage](nostr:nevent1qqsqt0gcggry60n72uglhuhypdlmr2dm6swjj69jex5v530gcpazlzsprpmhxue69uhhyetvv9ujumn0wdmksetjv5hxxmmdqy28wumn8ghj7un9d3shjtnyv9kh2uewd9hsygpm7rrrljungc6q0tuh5hj7ue863q73qlheu4vywtzwhx42a7j9n5ueneex) and Markdown is not powerful enough (besides being too freeform and unspecified and prone to generate incompatibilities in the future). + +Asciidoc has a strict spec, multiple implementations in many languages, and support for features that are very much necessary in a wiki article, like _sidebars_, _tables_ (with rich markup inside cells), many levels of _headings_, _footnotes_, _superscript_ and _subscript_ markup and _description lists_. It is also arguably easier to read in its plaintext format than Markdown (and certainly much better than Wikitext). + +## Appendix 1: Merge requests +Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. + +```json +{ + "content": "I added information about how to make hot ice-creams", + "kind": 818, + "tags": [ + [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], + [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>" ], + [ "p", "<destination-pubkey>" ], + [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] + ] +} +``` + +`.content`: an optional explanation detailing why this merge is being requested. +`a` tag: tag of the article which should be modified (i.e. the target of this merge request). +`e` tag: optional version of the article in which this modifications is based +`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP. + +The destination-pubkey is the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-` diff --git a/docs/nips/55.md b/docs/nips/55.md new file mode 100644 index 00000000..19d5ea98 --- /dev/null +++ b/docs/nips/55.md @@ -0,0 +1,586 @@ +NIP-55 +====== + +Android Signer Application +-------------------------- + +`draft` `optional` + +This NIP describes a method for 2-way communication between an Android signer and any Nostr client on Android. The Android signer is an Android Application and the client can be a web client or an Android application. + +## Usage for Android applications + +The Android signer uses Intents (to accept/reject permissions manually) and Content Resolvers (to accept/reject permissions automatically in background if the user allowed it) to communicate between applications. + +To be able to use the Android signer in your application you should add this to your AndroidManifest.xml: + +```xml +<queries> + <intent> + <action android:name="android.intent.action.VIEW" /> + <category android:name="android.intent.category.BROWSABLE" /> + <data android:scheme="nostrsigner" /> + </intent> +</queries> +``` + +Then you can use this function to check if there's a signer application installed: + +```kotlin +fun isExternalSignerInstalled(context: Context): Boolean { + val intent = + Intent().apply { + action = Intent.ACTION_VIEW + data = Uri.parse("nostrsigner:") + } + val infos = context.packageManager.queryIntentActivities(intent, 0) + return infos.size > 0 +} +``` + +### Using Intents + +To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. + +```kotlin +val launcher = rememberLauncherForActivityResult( + contract = ActivityResultContracts.StartActivityForResult(), + onResult = { result -> + if (result.resultCode != Activity.RESULT_OK) { + Toast.makeText( + context, + "Sign request rejected", + Toast.LENGTH_SHORT + ).show() + } else { + val result = activityResult.data?.getStringExtra("result") + // Do something with result ... + } + } +) +``` + +Create the Intent using the **nostrsigner** scheme: + +```kotlin +val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content")) +``` + +Set the Signer package name after you receive the response from **get_public_key** method: + +```kotlin +intent.`package` = "com.example.signer" +``` + +If you are sending multiple intents without awaiting you can add some intent flags to sign all events without opening multiple times the signer + +```kotlin +intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP) +``` + +If you are developing a signer application them you need to add this to your AndroidManifest.xml so clients can use the intent flags above + +```kotlin +android:launchMode="singleTop" +``` + +Signer MUST answer multiple permissions with an array of results + +```kotlin + +val results = listOf( + Result( + package = signerPackageName, + result = eventSignature, + id = intentId + ) +) + +val json = results.toJson() + +intent.putExtra("results", json) +``` + +Send the Intent: + +```kotlin +launcher.launch(intent) +``` + +#### Methods + +- **get_public_key** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) + intent.putExtra("type", "get_public_key") + // You can send some default permissions for the user to authorize for ever + val permissions = listOf( + Permission( + type = "sign_event", + kind = 22242 + ), + Permission( + type = "nip44_decrypt" + ) + ) + intent.putExtra("permissions", permissions.toJson()) + context.startActivity(intent) + ``` + - result: + - If the user approved the intent it will return the **pubkey** in the result field and the signer packageName in the **package** field + + ```kotlin + val pubkey = intent.data?.getStringExtra("result") + // The package name of the signer application + val packageName = intent.data?.getStringExtra("package") + ``` + +- **sign_event** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "sign_event") + // To handle results when not waiting between intents + intent.putExtra("id", event.id) + // Send the current logged in user pubkey + intent.putExtra("current_user", pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **result**, **id** and **event** fields + + ```kotlin + val signature = intent.data?.getStringExtra("result") + // The id you sent + val id = intent.data?.getStringExtra("id") + val signedEventJson = intent.data?.getStringExtra("event") + ``` + +- **nip04_encrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_encrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for encrypting the data + intent.putExtra("pubkey", pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **result** and **id** fields + + ```kotlin + val encryptedText = intent.data?.getStringExtra("result") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip44_encrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip44_encrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for encrypting the data + intent.putExtra("pubkey", pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val encryptedText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip04_decrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_decrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for decrypting the data + intent.putExtra("pubkey", pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **result** and **id** fields + + ```kotlin + val plainText = intent.data?.getStringExtra("result") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip44_decrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_decrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for decrypting the data + intent.putExtra("pubkey", pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **result** and **id** fields + + ```kotlin + val plainText = intent.data?.getStringExtra("result") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **decrypt_zap_event** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "decrypt_zap_event") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **result** and **id** fields + + ```kotlin + val eventJson = intent.data?.getStringExtra("result") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +### Using Content Resolver + +To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. + +If the user did not check the "remember my choice" option, the pubkey is not in Signer Application or the signer type is not recognized the `contentResolver` will return null + +For the SIGN_EVENT type Signer Application returns two columns "result" and "event". The column event is the signed event json + +For the other types Signer Application returns the column "result" + +If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application + +Clients SHOULD save the user pubkey locally and avoid calling the `get_public_key` after the user is logged in to the Client + +#### Methods + +- **get_public_key** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"), + listOf(hex_pub_key), + null, + null, + null + ) + ``` + - result: + - Will return the **pubkey** in the result column + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + if (index < 0) return + val pubkey = it.getString(index) + } + ``` + +- **sign_event** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.SIGN_EVENT"), + listOf("$eventJson", "", "${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **result** and the **event** columns + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + val indexJson = it.getColumnIndex("event") + val signature = it.getString(index) + val eventJson = it.getString(indexJson) + } + ``` + +- **nip04_encrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **result** column + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + val encryptedText = it.getString(index) + } + ``` + +- **nip44_encrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **result** column + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + val encryptedText = it.getString(index) + } + ``` + +- **nip04_decrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP04_DECRYPT"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **result** column + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + val encryptedText = it.getString(index) + } + ``` + +- **nip44_decrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP44_DECRYPT"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **result** column + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + val encryptedText = it.getString(index) + } + ``` + +- **decrypt_zap_event** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), + listOf("$eventJson", "", "${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **result** column + + ```kotlin + if (result == null) return + + if (it.getColumnIndex("rejected") > -1) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("result") + val eventJson = it.getString(index) + } + ``` + +## Usage for Web Applications + +You should consider using [NIP-46: Nostr Connect](46.md) for a better experience for web applications. When using this approach, the web app can't call the signer in the background, so the user will see a popup for every event you try to sign. + +Since web applications can't receive a result from the intent, you should add a modal to paste the signature or the event json or create a callback url. + +If you send the callback url parameter, Signer Application will send the result to the url. + +If you don't send a callback url, Signer Application will copy the result to the clipboard. + +You can configure the `returnType` to be **signature** or **event**. + +Android intents and browser urls have limitations, so if you are using the `returnType` of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base64 gzip encoded event json + +### Methods + +- **get_public_key** + - params: + + ```js + window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_public_key&callbackUrl=https://example.com/?event=`; + ``` + +- **sign_event** + - params: + + ```js + window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; + ``` + +- **nip04_encrypt** + - params: + + ```js + window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **nip44_encrypt** + - params: + + ```js + window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **nip04_decrypt** + - params: + + ```js + window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **nip44_decrypt** + - params: + + ```js + window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **decrypt_zap_event** + - params: + + ```js + window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`; + ``` + +### Example + +```js +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <title>Document</title> +</head> +<body> + <h1>Test</h1> + + <script> + window.onload = function() { + var url = new URL(window.location.href); + var params = url.searchParams; + if (params) { + var param1 = params.get("event"); + if (param1) alert(param1) + } + let json = { + kind: 1, + content: "test" + } + let encodedJson = encodeURIComponent(JSON.stringify(json)) + var newAnchor = document.createElement("a"); + newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; + newAnchor.textContent = "Open External Signer"; + document.body.appendChild(newAnchor) + } + </script> +</body> +</html> +``` diff --git a/docs/nips/56.md b/docs/nips/56.md new file mode 100644 index 00000000..dc6f0983 --- /dev/null +++ b/docs/nips/56.md @@ -0,0 +1,108 @@ +NIP-56 +====== + +Reporting +--------- + +`optional` + +A report is a `kind 1984` event that signals to users and relays that +some referenced content is objectionable. The definition of objectionable is +obviously subjective and all agents on the network (users, apps, relays, etc.) +may consume and take action on them as they see fit. + +The `content` MAY contain additional information submitted by the entity +reporting the content. + +Tags +---- + +The report event MUST include a `p` tag referencing the pubkey of the user you +are reporting. + +If reporting a note, an `e` tag MUST also be included referencing the note id. + +A `report type` string MUST be included as the 3rd entry to the `e`, `p` or `x` tag +being reported, which consists of the following report types: + +- `nudity` - depictions of nudity, porn, etc. +- `malware` - virus, trojan horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc. +- `profanity` - profanity, hateful speech, etc. +- `illegal` - something which may be illegal in some jurisdiction +- `spam` - spam +- `impersonation` - someone pretending to be someone else +- `other` - for reports that don't fit in the above categories + +Some report tags only make sense for profile reports, such as `impersonation`. + +- `x` tags SHOULD be info hash of a blob which is intended to be report. when the `x` tag is represented client MUST include an `e` tag which is the id of the event that contains the mentioned blob. also, additionally these events can contain a `server` tag to point to media servers which may contain the mentioned media. + +`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) to support +further qualification and querying. + +Example events +-------------- + +```jsonc +{ + "kind": 1984, + "tags": [ + ["p", "<pubkey>", "nudity"], + ["L", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"] + ], + "content": "", + // other fields... +} +``` + +```jsonc +{ + "kind": 1984, + "tags": [ + ["e", "<eventId>", "illegal"], + ["p", "<pubkey>"] + ], + "content": "He's insulting the king!", + // other fields... +} +``` + +```jsonc +{ + "kind": 1984, + "tags": [ + ["p", "<impersonator pubkey>", "impersonation"] + ], + "content": "Profile is impersonating nostr:<victim bech32 pubkey>", + // other fields... +} +``` + +```jsonc +{ + "kind": 1984, + "tags": [ + ["x", "<blob hash>", "malware"], + ["e", "<event id which contains the blob on x tag>", "malware"], + ["server", "https://you-may-find-the-blob-here.com/path-to-url.ext"] + ], + "content": "This file contains malware software in it.", + // other fields... +} +``` + +Client behavior +--------------- + +Clients can use reports from friends to make moderation decisions if they +choose to. For instance, if 3+ of your friends report a profile for `nudity`, +clients can have an option to automatically blur photos from said account. + + +Relay behavior +-------------- + +It is not recommended that relays perform automatic moderation using reports, +as they can be easily gamed. Admins could use reports from trusted moderators to +takedown illegal or explicit content if the relay does not allow such things. diff --git a/docs/nips/57.md b/docs/nips/57.md new file mode 100644 index 00000000..91eac306 --- /dev/null +++ b/docs/nips/57.md @@ -0,0 +1,191 @@ +NIP-57 +====== + +Lightning Zaps +-------------- + +`draft` `optional` + +This NIP defines two new event types for recording lightning payments between users. `9734` is a `zap request`, representing a payer's request to a recipient's lightning wallet for an invoice. `9735` is a `zap receipt`, representing the confirmation by the recipient's lightning wallet that the invoice issued in response to a `zap request` has been paid. + +Having lightning receipts on nostr allows clients to display lightning payments from entities on the network. These can be used for fun or for spam deterrence. + +## Protocol flow + +1. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. +2. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a `zap receipt` rather than a normal lnurl invoice. +3. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it. +4. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example. +5. The recipient's lnurl server will receive this `zap request` and validate it. See Appendix C for details on how to properly configure an lnurl server to support zaps, and Appendix D for details on how to validate the `nostr` query parameter. +6. If the `zap request` is valid, the server should fetch a description hash invoice where the description is this `zap request` note and this note only. No additional lnurl metadata is included in the description. This will be returned in the response according to [LUD06](https://github.com/lnurl/luds/blob/luds/06.md). +7. On receiving the invoice, the client MAY pay it or pass it to an app that can pay the invoice. +8. Once the invoice is paid, the recipient's lnurl server MUST generate a `zap receipt` as described in Appendix E, and publish it to the `relays` specified in the `zap request`. +9. Clients MAY fetch `zap receipt`s on posts and profiles, but MUST authorize their validity as described in Appendix F. If the `zap request` note contains a non-empty `content`, it may display a zap comment. Generally clients should show users the `zap request` note, and use the `zap receipt` to show "zap authorized by ..." but this is optional. + +## Reference and examples + +### Appendix A: Zap Request Event + +A `zap request` is an event of kind `9734` that is _not_ published to relays, but is instead sent to a recipient's lnurl pay `callback` url. This event's `content` MAY be an optional message to send along with the payment. The event MUST include the following tags: + +- `relays` is a list of relays the recipient's wallet should publish its `zap receipt` to. Note that relays should not be nested in an additional list, but should be included as shown in the example below. +- `amount` is the amount in _millisats_ the sender intends to pay, formatted as a string. This is recommended, but optional. +- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl`. This is recommended, but optional. +- `p` is the hex-encoded pubkey of the recipient. + +In addition, the event MAY include the following tags: + +- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. +- `a` is an optional event coordinate that allows tipping addressable events such as NIP-23 long-form notes. +- `k` is the stringified kind of the target event. + +Example: + +```json +{ + "kind": 9734, + "content": "Zap!", + "tags": [ + ["relays", "wss://nostr-pub.wellorder.com", "wss://anotherrelay.example.com"], + ["amount", "21000"], + ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"], + ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"], + ["e", "9ae37aa68f48645127299e9453eb5d908a0cbb6058ff340d528ed4d37c8994fb"], + ["k", "1"] + ], + "pubkey": "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322", + "created_at": 1679673265, + "id": "30efed56a035b2549fcaeec0bf2c1595f9a9b3bb4b1a38abaf8ee9041c4b7d93", + "sig": "f2cb581a84ed10e4dc84937bd98e27acac71ab057255f6aa8dfa561808c981fe8870f4a03c1e3666784d82a9c802d3704e174371aa13d63e2aeaf24ff5374d9d" +} +``` + +### Appendix B: Zap Request HTTP Request + +A signed `zap request` event is not published, but is instead sent using a HTTP GET request to the recipient's `callback` url, which was provided by the recipient's lnurl pay endpoint. This request should have the following query parameters defined: + +- `amount` is the amount in _millisats_ the sender intends to pay +- `nostr` is the `9734` `zap request` event, JSON encoded then URI encoded +- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl` + +This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize their zap. Here is an example flow in javascript: + +```javascript +const senderPubkey // The sender's pubkey +const recipientPubkey = // The recipient's pubkey +const callback = // The callback received from the recipients lnurl pay endpoint +const lnurl = // The recipient's lightning address, encoded as a lnurl +const sats = 21 + +const amount = sats * 1000 +const relays = ['wss://nostr-pub.wellorder.net'] +const event = encodeURI(JSON.stringify(await signEvent({ + kind: 9734, + content: "", + pubkey: senderPubkey, + created_at: Math.round(Date.now() / 1000), + tags: [ + ["relays", ...relays], + ["amount", amount.toString()], + ["lnurl", lnurl], + ["p", recipientPubkey], + ], +}))) + +const {pr: invoice} = await fetchJson(`${callback}?amount=${amount}&nostr=${event}&lnurl=${lnurl}`) +``` + +### Appendix C: LNURL Server Configuration + +The lnurl server will need some additional pieces of information so that clients can know that zap invoices are supported: + +1. Add a `nostrPubkey` to the lnurl-pay static endpoint `/.well-known/lnurlp/<user>`, where `nostrPubkey` is the nostr pubkey your server will use to sign `zap receipt` events. Clients will use this to validate `zap receipt`s. +2. Add an `allowsNostr` field and set it to true. + +### Appendix D: LNURL Server Zap Request Validation + +When a client sends a `zap request` event to a server's lnurl-pay callback URL, there will be a `nostr` query parameter whose value is that event which is URI- and JSON-encoded. If present, the `zap request` event must be validated in the following ways: + +1. It MUST have a valid nostr signature +2. It MUST have tags +3. It MUST have only one `p` tag +4. It MUST have 0 or 1 `e` tags +5. There should be a `relays` tag with the relays to send the `zap receipt` to. +6. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. +7. If there is an `a` tag, it MUST be a valid event coordinate +8. There MUST be 0 or 1 `P` tags. If there is one, it MUST be equal to the `zap receipt`'s `pubkey`. + +The event MUST then be stored for use later, when the invoice is paid. + +### Appendix E: Zap Receipt Event + +A `zap receipt` is created by a lightning node when an invoice generated by a `zap request` is paid. `Zap receipt`s are only created when the invoice description (committed to the description hash) contains a `zap request` note. + +When receiving a payment, the following steps are executed: + +1. Get the description for the invoice. This needs to be saved somewhere during the generation of the description hash invoice. It is saved automatically for you with CLN, which is the reference implementation used here. +2. Parse the bolt11 description as a JSON nostr event. This SHOULD be validated based on the requirements in Appendix D, either when it is received, or before the invoice is paid. +3. Create a nostr event of kind `9735` as described below, and publish it to the `relays` declared in the `zap request`. + +The following should be true of the `zap receipt` event: + +- The `content` SHOULD be empty. +- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. +- `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). +- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. +- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. +- `SHA256(description)` SHOULD match the description hash in the bolt11 invoice. +- The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. + +The `zap receipt` is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the `zap receipt` implies the invoice as paid, but it could be a lie given a rogue implementation. + +A reference implementation for a zap-enabled lnurl server can be found [here](https://github.com/jb55/cln-nostr-zapper). + +Example `zap receipt`: + +```json +{ + "id": "67b48a14fb66c60c8f9070bdeb37afdfcc3d08ad01989460448e4081eddda446", + "pubkey": "9630f464cca6a5147aa8a35f0bcdd3ce485324e732fd39e09233b1d848238f31", + "created_at": 1674164545, + "kind": 9735, + "tags": [ + ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], + ["P", "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322"], + ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"], + ["k", "1"], + ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"], + ["description", "{\"pubkey\":\"97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], + ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"] + ], + "content": "", + } +``` + +### Appendix F: Validating Zap Receipts + +A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter, for example `{"kinds": [9735], "#e": [...]}`. Zaps MUST be validated using the following steps: + +- The `zap receipt` event's `pubkey` MUST be the same as the recipient's lnurl provider's `nostrPubkey` (retrieved in step 1 of the protocol flow). +- The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present). +- The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. + +### Appendix G: `zap` tag on other events + +When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). + +```jsonc +{ + "tags": [ + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50% + ] +} +``` + +Clients MAY display the zap split configuration in the note. + +## Future Work + +Zaps can be extended to be more private by encrypting `zap request` notes to the target user, but for simplicity it has been left out of this initial draft. diff --git a/docs/nips/58.md b/docs/nips/58.md new file mode 100644 index 00000000..23921bdd --- /dev/null +++ b/docs/nips/58.md @@ -0,0 +1,123 @@ +NIP-58 +====== + +Badges +------ + +`draft` `optional` + +Three special events are used to define, award and display badges in +user profiles: + +1. A "Badge Definition" event is defined as an addressable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated. + +2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. + +3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`. +Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed. + +### Badge Definition event + +The following tags MUST be present: + +- `d` tag with the unique name of the badge. + +The following tags MAY be present: + +- A `name` tag with a short name for the badge. +- `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels. +- A `description` tag whose value MAY contain a textual representation of the +image, the meaning behind the badge, or the reason of its issuance. +- One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels. + +### Badge Award event + +The following tags MUST be present: + +- An `a` tag referencing a kind `30009` Badge Definition event. +- One or more `p` tags referencing each pubkey awarded. + +### Profile Badges Event + +The number of badges a pubkey can be awarded is unbounded. The Profile Badge +event allows individual users to accept or reject awarded badges, as well +as choose the display order of badges on their profiles. + +The following tags MUST be present: + +- A `d` tag with the unique identifier `profile_badges` + +The following tags MAY be present: + +- Zero or more ordered consecutive pairs of `a` and `e` tags referencing a kind `30009` Badge Definition and kind `8` Badge Award, respectively. Clients SHOULD +ignore `a` without corresponding `e` tag and viceversa. Badge Awards referenced +by the `e` tags should contain the same `a` tag. + +### Motivation + +Users MAY be awarded badges (but not limited to) in recognition, in gratitude, for participation, or in appreciation of a certain goal, task or cause. + +Users MAY choose to decorate their profiles with badges for fame, notoriety, recognition, support, etc., from badge issuers they deem reputable. + +### Recommendations + +Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users. + +Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels. + +Badge thumbnail image recommended dimensions are: 512x512 (xl), 256x256 (l), 64x64 (m), 32x32 (s) and 16x16 (xs). + +Clients MAY choose to render less badges than those specified by users in the Profile Badges event or replace the badge image and thumbnails with ones that fits the theme of the client. + +Clients SHOULD attempt to render the most appropriate badge thumbnail according to the number of badges chosen by the user and space available. Clients SHOULD attempt render the high-res version on user action (click, tap, hover). + +### Example of a Badge Definition event + +```jsonc +{ + "pubkey": "alice", + "kind": 30009, + "tags": [ + ["d", "bravery"], + ["name", "Medal of Bravery"], + ["description", "Awarded to users demonstrating bravery"], + ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], + ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"] + ], + // other fields... +} +``` + +### Example of Badge Award event + +```jsonc +{ + "id": "<badge award event id>", + "kind": 8, + "pubkey": "alice", + "tags": [ + ["a", "30009:alice:bravery"], + ["p", "bob", "wss://relay"], + ["p", "charlie", "wss://relay"] + ], + // other fields... +} +``` + +### Example of a Profile Badges event + +Honorable Bob The Brave: +```jsonc +{ + "kind": 30008, + "pubkey": "bob", + "tags": [ + ["d", "profile_badges"], + ["a", "30009:alice:bravery"], + ["e", "<bravery badge award event id>", "wss://nostr.academy"], + ["a", "30009:alice:honor"], + ["e", "<honor badge award event id>", "wss://nostr.academy"] + ], + // other fields... +} +``` diff --git a/docs/nips/59.md b/docs/nips/59.md new file mode 100644 index 00000000..6abf1cd4 --- /dev/null +++ b/docs/nips/59.md @@ -0,0 +1,255 @@ +NIP-59 +====== + +Gift Wrap +--------- + +`optional` + +This NIP defines a protocol for encapsulating any nostr event. This makes it possible to obscure most metadata +for a given event, perform collaborative signing, and more. + +This NIP *does not* define any messaging protocol. Applications of this NIP should be defined separately. + +This NIP relies on [NIP-44](./44.md)'s versioned encryption algorithms. + +## Overview + +This protocol uses three main concepts to protect the transmission of a target event: `rumor`s, `seal`s, and `gift wrap`s. + +- A `rumor` is a regular nostr event, but is **not signed**. This means that if it is leaked, it cannot be verified. +- A `rumor` is serialized to JSON, encrypted, and placed in the `content` field of a `seal`. The `seal` is then + signed by the author of the note. The only information publicly available on a `seal` is who signed it, but not what was said. +- A `seal` is serialized to JSON, encrypted, and placed in the `content` field of a `gift wrap`. + +This allows the isolation of concerns across layers: + +- A rumor carries the content but is unsigned, which means if leaked it will be rejected by relays and clients, + and can't be authenticated. This provides a measure of deniability. +- A seal identifies the author without revealing the content or the recipient. +- A gift wrap can add metadata (recipient, tags, a different author) without revealing the true author. + +## Protocol Description + +### 1. The Rumor Event Kind + +A `rumor` is the same thing as an unsigned event. Any event kind can be made a `rumor` by removing the signature. + +### 2. The Seal Event Kind + +A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key. The `seal` is **always** encrypted +to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for +without the receiver's or the sender's private key. The only public information in this event is who is signing it. + +```json +{ + "id": "<id>", + "pubkey": "<real author's pubkey>", + "content": "<encrypted rumor>", + "kind": 13, + "created_at": 1686840217, + "tags": [], + "sig": "<real author's pubkey signature>" +} +``` + +Tags MUST always be empty in a `kind:13`. The inner event MUST always be unsigned. + +### 3. Gift Wrap Event Kind + +A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information +needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work. + +```json +{ + "id": "<id>", + "pubkey": "<random, one-time-use pubkey>", + "content": "<encrypted kind 13>", + "kind": 1059, + "created_at": 1686840217, + "tags": [["p", "<recipient pubkey>"]], + "sig": "<random, one-time-use pubkey signature>" +} +``` + +## Encrypting Payloads + +Encryption is done following [NIP-44](44.md) on the JSON-encoded event. Place the encryption payload in the `.content` +of the wrapper event (either a `seal` or a `gift wrap`). + +## Other Considerations + +If a `rumor` is intended for more than one party, or if the author wants to retain an encrypted copy, a single +`rumor` may be wrapped and addressed for each recipient individually. + +The canonical `created_at` time belongs to the `rumor`. All other timestamps SHOULD be tweaked to thwart +time-analysis attacks. Note that some relays don't serve events dated in the future, so all timestamps +SHOULD be in the past. + +Relays may choose not to store gift wrapped events due to them not being publicly useful. Clients MAY choose +to attach a certain amount of proof-of-work to the wrapper event per [NIP-13](13.md) in a bid to demonstrate that +the event is not spam or a denial-of-service attack. + +To protect recipient metadata, relays SHOULD guard access to `kind 1059` events based on user AUTH. When +possible, clients should only send wrapped events to relays that offer this protection. + +To protect recipient metadata, relays SHOULD only serve `kind 1059` events intended for the marked recipient. +When possible, clients should only send wrapped events to `read` relays for the recipient that implement +AUTH, and refuse to serve wrapped events to non-recipients. + +When adding expiration tags to both `seal` and `gift wrap` layers, implementations SHOULD use independent random timestamps for each layer. Using different `created_at` values increases timing variance and helps protect against metadata correlation attacks. + + +## An Example + +Let's send a wrapped `kind 1` message between two parties asking "Are you going to the party tonight?" + +- Author private key: `0beebd062ec8735f4243466049d7747ef5d6594ee838de147f8aab842b15e273` +- Recipient private key: `e108399bd8424357a710b606ae0c13166d853d327e47a6e5e038197346bdbf45` +- Ephemeral wrapper key: `4f02eac59266002db5801adc5270700ca69d5b8f761d8732fab2fbf233c90cbd` + +Note that this messaging protocol should not be used in practice, this is just an example. Refer to other +NIPs for concrete messaging protocols that depend on gift wraps. + +### 1. Create an event + +Create a `kind 1` event with the message, the receivers, and any other tags you want, signed by the author. +Do not sign the event. + +```json +{ + "created_at": 1691518405, + "content": "Are you going to the party tonight?", + "tags": [], + "kind": 1, + "pubkey": "611df01bfcf85c26ae65453b772d8f1dfd25c264621c0277e1fc1518686faef9", + "id": "9dd003c6d3b73b74a85a9ab099469ce251653a7af76f523671ab828acd2a0ef9" +} +``` + +### 2. Seal the rumor + +Encrypt the JSON-encoded `rumor` with a conversation key derived using the author's private key and +the recipient's public key. Place the result in the `content` field of a `kind 13` `seal` event. Sign +it with the author's key. + +```json +{ + "content": "AqBCdwoS7/tPK+QGkPCadJTn8FxGkd24iApo3BR9/M0uw6n4RFAFSPAKKMgkzVMoRyR3ZS/aqATDFvoZJOkE9cPG/TAzmyZvr/WUIS8kLmuI1dCA+itFF6+ULZqbkWS0YcVU0j6UDvMBvVlGTzHz+UHzWYJLUq2LnlynJtFap5k8560+tBGtxi9Gx2NIycKgbOUv0gEqhfVzAwvg1IhTltfSwOeZXvDvd40rozONRxwq8hjKy+4DbfrO0iRtlT7G/eVEO9aJJnqagomFSkqCscttf/o6VeT2+A9JhcSxLmjcKFG3FEK3Try/WkarJa1jM3lMRQqVOZrzHAaLFW/5sXano6DqqC5ERD6CcVVsrny0tYN4iHHB8BHJ9zvjff0NjLGG/v5Wsy31+BwZA8cUlfAZ0f5EYRo9/vKSd8TV0wRb9DQ=", + "kind": 13, + "created_at": 1703015180, + "pubkey": "611df01bfcf85c26ae65453b772d8f1dfd25c264621c0277e1fc1518686faef9", + "tags": [], + "id": "28a87d7c074d94a58e9e89bb3e9e4e813e2189f285d797b1c56069d36f59eaa7", + "sig": "02fc3facf6621196c32912b1ef53bac8f8bfe9db51c0e7102c073103586b0d29c3f39bdaa1e62856c20e90b6c7cc5dc34ca8bb6a528872cf6e65e6284519ad73" +} +``` + +### 3. Wrap the seal + +Encrypt the JSON-encoded `kind 13` event with your ephemeral, single-use random key. Place the result +in the `content` field of a `kind 1059`. Add a single `p` tag containing the recipient's public key. +Sign the `gift wrap` using the random key generated in the previous step. + +```json +{ + "content": "AhC3Qj/QsKJFWuf6xroiYip+2yK95qPwJjVvFujhzSguJWb/6TlPpBW0CGFwfufCs2Zyb0JeuLmZhNlnqecAAalC4ZCugB+I9ViA5pxLyFfQjs1lcE6KdX3euCHBLAnE9GL/+IzdV9vZnfJH6atVjvBkNPNzxU+OLCHO/DAPmzmMVx0SR63frRTCz6Cuth40D+VzluKu1/Fg2Q1LSst65DE7o2efTtZ4Z9j15rQAOZfE9jwMCQZt27rBBK3yVwqVEriFpg2mHXc1DDwHhDADO8eiyOTWF1ghDds/DxhMcjkIi/o+FS3gG1dG7gJHu3KkGK5UXpmgyFKt+421m5o++RMD/BylS3iazS1S93IzTLeGfMCk+7IKxuSCO06k1+DaasJJe8RE4/rmismUvwrHu/HDutZWkvOAhd4z4khZo7bJLtiCzZCZ74lZcjOB4CYtuAX2ZGpc4I1iOKkvwTuQy9BWYpkzGg3ZoSWRD6ty7U+KN+fTTmIS4CelhBTT15QVqD02JxfLF7nA6sg3UlYgtiGw61oH68lSbx16P3vwSeQQpEB5JbhofW7t9TLZIbIW/ODnI4hpwj8didtk7IMBI3Ra3uUP7ya6vptkd9TwQkd/7cOFaSJmU+BIsLpOXbirJACMn+URoDXhuEtiO6xirNtrPN8jYqpwvMUm5lMMVzGT3kMMVNBqgbj8Ln8VmqouK0DR+gRyNb8fHT0BFPwsHxDskFk5yhe5c/2VUUoKCGe0kfCcX/EsHbJLUUtlHXmTqaOJpmQnW1tZ/siPwKRl6oEsIJWTUYxPQmrM2fUpYZCuAo/29lTLHiHMlTbarFOd6J/ybIbICy2gRRH/LFSryty3Cnf6aae+A9uizFBUdCwTwffc3vCBae802+R92OL78bbqHKPbSZOXNC+6ybqziezwG+OPWHx1Qk39RYaF0aFsM4uZWrFic97WwVrH5i+/Nsf/OtwWiuH0gV/SqvN1hnkxCTF/+XNn/laWKmS3e7wFzBsG8+qwqwmO9aVbDVMhOmeUXRMkxcj4QreQkHxLkCx97euZpC7xhvYnCHarHTDeD6nVK+xzbPNtzeGzNpYoiMqxZ9bBJwMaHnEoI944Vxoodf51cMIIwpTmmRvAzI1QgrfnOLOUS7uUjQ/IZ1Qa3lY08Nqm9MAGxZ2Ou6R0/Z5z30ha/Q71q6meAs3uHQcpSuRaQeV29IASmye2A2Nif+lmbhV7w8hjFYoaLCRsdchiVyNjOEM4VmxUhX4VEvw6KoCAZ/XvO2eBF/SyNU3Of4SO", + "kind": 1059, + "created_at": 1703021488, + "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c", + "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac", + "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259", + "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]], +} +``` + +### 4. Broadcast Selectively + +Broadcast the `kind 1059` event to the recipient's relays only. Delete all the other events. + +## Code Samples + +### JavaScript + +```javascript +import {bytesToHex} from "@noble/hashes/utils" +import type {EventTemplate, UnsignedEvent, Event} from "nostr-tools" +import {getPublicKey, getEventHash, nip19, nip44, finalizeEvent, generateSecretKey} from "nostr-tools" + +type Rumor = UnsignedEvent & {id: string} + +const TWO_DAYS = 2 * 24 * 60 * 60 + +const now = () => Math.round(Date.now() / 1000) +const randomNow = () => Math.round(now() - (Math.random() * TWO_DAYS)) + +const nip44ConversationKey = (privateKey: Uint8Array, publicKey: string) => + nip44.v2.utils.getConversationKey(bytesToHex(privateKey), publicKey) + +const nip44Encrypt = (data: EventTemplate, privateKey: Uint8Array, publicKey: string) => + nip44.v2.encrypt(JSON.stringify(data), nip44ConversationKey(privateKey, publicKey)) + +const nip44Decrypt = (data: Event, privateKey: Uint8Array) => + JSON.parse(nip44.v2.decrypt(data.content, nip44ConversationKey(privateKey, data.pubkey))) + +const createRumor = (event: Partial<UnsignedEvent>, privateKey: Uint8Array) => { + const rumor = { + created_at: now(), + content: "", + tags: [], + ...event, + pubkey: getPublicKey(privateKey), + } as any + + rumor.id = getEventHash(rumor) + + return rumor as Rumor +} + +const createSeal = (rumor: Rumor, privateKey: Uint8Array, recipientPublicKey: string) => { + return finalizeEvent( + { + kind: 13, + content: nip44Encrypt(rumor, privateKey, recipientPublicKey), + created_at: randomNow(), + tags: [], + }, + privateKey + ) as Event +} + +const createWrap = (event: Event, recipientPublicKey: string) => { + const randomKey = generateSecretKey() + + return finalizeEvent( + { + kind: 1059, + content: nip44Encrypt(event, randomKey, recipientPublicKey), + created_at: randomNow(), + tags: [["p", recipientPublicKey]], + }, + randomKey + ) as Event +} + +// Test case using the above example +const senderPrivateKey = nip19.decode(`nsec1p0ht6p3wepe47sjrgesyn4m50m6avk2waqudu9rl324cg2c4ufesyp6rdg`).data +const recipientPrivateKey = nip19.decode(`nsec1uyyrnx7cgfp40fcskcr2urqnzekc20fj0er6de0q8qvhx34ahazsvs9p36`).data +const recipientPublicKey = getPublicKey(recipientPrivateKey) + +const rumor = createRumor( + { + kind: 1, + content: "Are you going to the party tonight?", + }, + senderPrivateKey +) + +const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey) +const wrap = createWrap(seal, recipientPublicKey) + +// Recipient unwraps with their private key. + +const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey) +const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey) +``` diff --git a/docs/nips/60.md b/docs/nips/60.md new file mode 100644 index 00000000..786ce977 --- /dev/null +++ b/docs/nips/60.md @@ -0,0 +1,186 @@ +NIP-60 +====== + +Cashu Wallets +------------- + +`draft` `optional` + +This NIP defines the operations of a cashu-based wallet. + +A cashu wallet is a wallet which information is stored in relays to make it accessible across applications. + +The purpose of this NIP is: +* ease-of-use: new users immediately are able to receive funds without creating accounts with other services. +* interoperability: users' wallets follows them across applications. + +This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. + +## High-level flow +1. A user has a `kind:17375` event that represents a wallet. +2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. +3. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional. + +### Wallet Event +```jsonc +{ + "kind": 17375, + "content": nip44_encrypt([ + [ "privkey", "hexkey" ], + [ "mint", "https://mint1" ], + [ "mint", "https://mint2" ] + ]), + "tags": [] +} +``` + +The wallet event is an replaceable event `kind:17375`. + +Tags: +* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. +* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's Nostr private key** -- This is only used for receiving [NIP-61](61.md) nutzaps. + +### Token Event +Token events are used to record unspent proofs. + +There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. + +```jsonc +{ + "kind": 7375, + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + // one or more proofs in the default cashu format + { + "id": "005c2502034d4f12", + "amount": 1, + "secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=", + "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" + } + ], + // tokens that were destroyed in the creation of this token (helps on wallet state transitions) + "del": [ "token-event-id-1", "token-event-id-2" ] + }), + "tags": [] +} +``` + + * `.content` is a [NIP-44](44.md) encrypted payload: + * `mint`: The mint the proofs belong to. + * `proofs`: unencoded proofs + * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. + +When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event (the change output should include a `del` field). + +The `kind:5` _delete event_ created in the [NIP-09](09.md) process MUST have a tag `["k", "7375"]` to allow easy filtering by clients interested in state transitions. + +### Spending History Event +Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. + +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "in" ], // in = received, out = sent + [ "amount", "1" ], + [ "e", "<event-id-of-created-token>", "", "created" ] + ]), + "tags": [ + [ "e", "<event-id-of-created-token>", "", "redeemed" ] + ] +} +``` + +* `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. + +Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: +* `created` - A new token event was created. +* `destroyed` - A token event was destroyed. +* `redeemed` - A [NIP-61](61.md) nutzap was redeemed. + +All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. + +Multiple `e` tags can be added, and should be encrypted, except for tags with the `redeemed` marker. + +## Flow +A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [NIP-65](65.md) relays. + +### Fetch wallet and token list +From those relays, the client should fetch wallet and token events. + +`"kinds": [17375, 7375], "authors": ["<my-pubkey>"]` + +### Fetch proofs + +### Spending token +If Alice spends 4 sats from this token event +```jsonc +{ + "kind": 7375, + "id": "event-id-1", + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { "id": "1", "amount": 1 }, + { "id": "2", "amount": 2 }, + { "id": "3", "amount": 4 }, + { "id": "4", "amount": 8 }, + ] + }), + "tags": [] +} +``` + +Her client: +* MUST roll over the unspent proofs: +```jsonc +{ + "kind": 7375, + "id": "event-id-2", + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { "id": "1", "amount": 1 }, + { "id": "2", "amount": 2 }, + { "id": "4", "amount": 8 }, + ], + "del": [ "event-id-1" ] + }), + "tags": [] +} +``` +* MUST delete event `event-id-1` +* SHOULD add the `event-id-1` to the `del` array of deleted token-ids. +* SHOULD create a `kind:7376` event to record the spend +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "out" ], + [ "amount", "4" ], + [ "e", "<event-id-1>", "", "destroyed" ], + [ "e", "<event-id-2>", "", "created" ], + ]), + "tags": [] +} +``` + +### Redeeming a quote (optional) +When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [NIP-40](40.md) of 2 weeks (which is around the maximum amount of time a Lightning payment may be in-flight). + +However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application. + +```jsonc +{ + "kind": 7374, + "content": nip44_encrypt("quote-id"), + "tags": [ + [ "expiration", "<expiration-timestamp>" ], + [ "mint", "<mint-url>" ] + ] +} +``` + +## Appendix 1: Validating proofs +Clients can optionally validate proofs to make sure they are not working from an old state; this logic is left up to particular implementations to decide when and why to do it, but if some proofs are checked and deemed to have been spent, the client should delete the token and roll over any unspent proof. diff --git a/docs/nips/61.md b/docs/nips/61.md new file mode 100644 index 00000000..5ef7f680 --- /dev/null +++ b/docs/nips/61.md @@ -0,0 +1,122 @@ +NIP-61 +====== + +Nutzaps +------- + +`draft` `optional` + +A Nutzap is a P2PK Cashu token in which the payment itself is the receipt. + +## High-level flow +Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. + +### Alice nutzaps Bob +1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. +2. She mints a token at that mint (or swaps some tokens she already had in that mint) P2PK-locked to the pubkey Bob has listed in his `kind:10019`. +3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. + +### Bob receives the nutzap +1. At some point, Bob's client fetches `kind:9321` events p-tagging him from his relays. +2. Bob's client swaps the token into his wallet. + +## Nutzap informational event +```jsonc +{ + "kind": 10019, + "tags": [ + [ "relay", "wss://relay1" ], + [ "relay", "wss://relay2" ], + [ "mint", "https://mint1", "usd", "sat" ], + [ "mint", "https://mint2", "sat" ], + [ "pubkey", "<p2pk-pubkey>" ] + ] +} +``` + +* `kind:10019` is an event that is useful for others to know how to send money to the user. +* `relay`: relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays. +* `mint`: mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint. +* `pubkey`: Public key that MUST be used to P2PK-lock receiving nutzaps -- implementations MUST NOT use the target user's main Nostr public key. This public key corresponds to the `privkey` field encrypted in a user's [nip-60](60.md) _wallet event_. + +### Nutzap event +Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the public key the recipient indicated in their `kind:10019` event. + +Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu compatibility). + +```jsonc +{ + "kind": 9321, + "content": "Thanks for this great idea.", + "pubkey": "<sender-pubkey>", + "tags": [ + [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], + [ "u", "https://stablenut.umint.cash" ], + [ "e", "<nutzapped-event-id>", "<relay-hint>" ], + [ "k", "<nutzapped-kind>"], + [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap + ] +} +``` + +* `.content` is an optional comment for the nutzap +* `.tags`: + * `proof` is one or more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. + * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. + * `p` is the Nostr identity public key of nutzap recipient. + * `e` is the event that is being nutzapped, if any. + +## Sending a nutzap + +* The sender fetches the recipient's `kind:10019`. +* The sender mints/swaps ecash on one of the recipient's listed mints. +* The sender P2PK-locks to the recipient's specified public key in their `kind:10019` + +## Receiving nutzaps + +Clients should REQ for nutzaps: +* Filtering with `#u` for mints they expect to receive ecash from. + * this is to prevent even interacting with mints the user hasn't explicitly signaled. +* Filtering with `since` of the most recent `kind:7376` event the same user has created. + * this can be used as a marker of the nutzaps that have already been swapped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach. + +`{ "kinds": [9321], "#p": ["my-pubkey"], "#u": ["<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. + +Upon receiving a new nutzap, the client should swap the tokens into a wallet the user controls, either a [NIP-60](60.md) wallet, their own LN wallet or anything else. + +### Updating nutzap-redemption history +When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nutzap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed. + +Multiple `kind:9321` events can be tagged in the same `kind:7376` event. + +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "in" ], // in = received, out = sent + [ "amount", "1" ], + [ "e", "<7375-event-id>", "<relay-hint>", "created" ] // new token event that was created + ]), + "tags": [ + [ "e", "<9321-event-id>", "<relay-hint>", "redeemed" ], // nutzap event that has been redeemed + [ "p", "<sender-pubkey>" ] // pubkey of the author of the 9321 event (nutzap sender) + ] +} +``` + +Events that redeem a nutzap SHOULD be published to the sender's [NIP-65](65.md) "read" relays. + +### Verifying a Cashu Zap +When listing or counting zaps received by any given event, observer clients SHOULD: + +* check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. +* check that the token is locked to the pubkey the user has listed in their `kind:10019`. +* look at the `u` tag and check that the token is issued in one of the mints listed in the `kind:10019`. +* locally verify the DLEQ proof of the tokens being sent. + +All these checks can be done offline (as long as the observer has the receiver mints' keyset and their `kind:10019` event), so the process should be reasonably fast. + +### Final Considerations +1. Clients SHOULD guide their users to use NUT-11 (P2PK) and NUT-12 (DLEQ proofs) compatible-mints in their `kind:10019` event to avoid receiving nutzaps anyone can spend. +2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. +3. A nutzap event MUST include proofs in one of the mints the recipient has listed in their `kind:10019` and published to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event. diff --git a/docs/nips/62.md b/docs/nips/62.md new file mode 100644 index 00000000..a00ddfc0 --- /dev/null +++ b/docs/nips/62.md @@ -0,0 +1,61 @@ +NIP-62 +====== + +Request to Vanish +----------------- + +`draft` `optional` + +This NIP offers a Nostr-native way to request a complete reset of a key's fingerprint on the web. This procedure is legally binding in some jurisdictions, and thus, supporters of this NIP should truly delete events from their database. + +## Request to Vanish from Relay + +Kind `62` requests a specific relay to delete everything, including [NIP-09](09.md) Deletion Events, from the `.pubkey` until its `.created_at`. + +```jsonc +{ + "kind": 62, + "pubkey": <32-byte hex-encoded public key of the event creator>, + "tags": [ + ["relay", "<relay url>"] + ], + "content": "<reason or note>", + //...other fields +} +``` + +The tag list MUST include at least one `relay` value. + +Content MAY include a reason or a legal notice to the relay operator. + +Relays MUST fully delete any events from the `.pubkey` if their service URL is tagged in the event. + +Relays SHOULD delete all [NIP-59](59.md) Gift Wraps that p-tagged the `.pubkey` if their service URL is tagged in the event, deleting all DMs to the pubkey. + +Relays MUST ensure the deleted events cannot be re-broadcasted into the relay. + +Relays MAY store the signed request to vanish for bookkeeping. + +Paid relays or relays that restrict who can post MUST also follow the request to vanish regardless of the user's status. + +Publishing a deletion request event (Kind `5`) against a request to vanish has no effect. Clients and relays are not obliged to support "unrequest vanish" functionality. + +Clients SHOULD send this event to the target relays only. + +## Global Request to Vanish + +To request ALL relays to delete everything, the event MUST include a `relay` tag with the value `ALL_RELAYS` in uppercase. + +```jsonc +{ + "kind": 62, + "pubkey": <32-byte hex-encoded public key of the event creator>, + "tags": [ + ["relay", "ALL_RELAYS"] + ], + "content": "<reason>", + //...other fields +} +``` + +Clients SHOULD broadcast this event to as many relays as possible. diff --git a/docs/nips/64.md b/docs/nips/64.md new file mode 100644 index 00000000..48bdd2b4 --- /dev/null +++ b/docs/nips/64.md @@ -0,0 +1,146 @@ +NIP-64 +====== + +Chess (Portable Game Notation) +------------------------------ + +`draft` `optional` + +This NIP defines `kind:64` notes representing chess games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software. + +## Note + +### Content + +The `.content` of these notes is a string representing a [PGN-database][pgn_formal_syntax]. + +### Notes + +```jsonc +{ + "kind": 64, + "content": "1. e4 *", + // other fields... +} +``` + +```jsonc +{ + "kind": 64, + "tags": [ + ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], + // rest of tags... + ], + "content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2", + // other fields... +} +``` + +## Client Behavior + +Clients SHOULD display the content represented as chessboard. + +Clients SHOULD publish PGN notes in ["export format"][pgn_export_format] ("strict mode", i.e. created by machines) but expect incoming notes to be in ["import format"][pgn_import_format] ("lax mode", i.e. created by humans). + +Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. + +Clients MAY include additional tags (e.g. like [`"alt"`](31.md)) in order to represent the note to users of non-supporting clients. + +## Relay Behavior + +Relays MAY validate PGN contents and reject invalid notes. + + +## Examples + +```pgn +// A game where nothing is known. Game still in progress, game abandoned, or result otherwise unknown. +// Maybe players died before a move has been made. +* +``` + +```pgn +1. e4 * +``` + +```pgn +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} * +``` + +```pgn +[Event "F/S Return Match"] +[Site "Belgrade, Serbia JUG"] +[Date "1992.11.04"] +[Round "29"] +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] +[Result "1/2-1/2"] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6 +4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 +11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 +Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 +23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 +hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 +35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 +Nf2 42. g4 Bd3 43. Re6 1/2-1/2 +``` + +```pgn +[Event "Hourly HyperBullet Arena"] +[Site "https://lichess.org/wxx4GldJ"] +[Date "2017.04.01"] +[White "T_LUKE"] +[Black "decidement"] +[Result "1-0"] +[UTCDate "2017.04.01"] +[UTCTime "11:56:14"] +[WhiteElo "2047"] +[BlackElo "1984"] +[WhiteRatingDiff "+10"] +[BlackRatingDiff "-7"] +[Variant "Standard"] +[TimeControl "30+0"] +[ECO "B00"] +[Termination "Abandoned"] + +1. e4 1-0 + + +[Event "Hourly HyperBullet Arena"] +[Site "https://lichess.org/rospUdSk"] +[Date "2017.04.01"] +[White "Bastel"] +[Black "oslochess"] +[Result "1-0"] +[UTCDate "2017.04.01"] +[UTCTime "11:55:56"] +[WhiteElo "2212"] +[BlackElo "2000"] +[WhiteRatingDiff "+6"] +[BlackRatingDiff "-4"] +[Variant "Standard"] +[TimeControl "30+0"] +[ECO "A01"] +[Termination "Normal"] + +1. b3 d5 2. Bb2 c6 3. Nc3 Bf5 4. d4 Nf6 5. e3 Nbd7 6. f4 Bg6 7. Nf3 Bh5 8. Bd3 e6 9. O-O Be7 10. Qe1 O-O 11. Ne5 Bg6 12. Nxg6 hxg6 13. e4 dxe4 14. Nxe4 Nxe4 15. Bxe4 Nf6 16. c4 Bd6 17. Bc2 Qc7 18. f5 Be7 19. fxe6 fxe6 20. Qxe6+ Kh8 21. Qh3+ Kg8 22. Bxg6 Qd7 23. Qe3 Bd6 24. Bf5 Qe7 25. Be6+ Kh8 26. Qh3+ Nh7 27. Bf5 Rf6 28. Qxh7# 1-0 +``` + +## Resources +- [PGN Specification][pgn_specification]: PGN (Portable Game Notation) specification +- [PGN Specification Supplement](https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-spec-supplement.md): Addition for adding graphical elements, clock values, eval, ... +- [PGN Formal Syntax][pgn_formal_syntax] +- [PGN Seven Tag Roster][pgn_seven_tag_roster] +- [PGN Import Format][pgn_import_format] +- [PGN Export Format][pgn_export_format] +- [lichess / pgn-viewer (GitHub)](https://github.com/lichess-org/pgn-viewer): PGN viewer widget, designed to be embedded in content pages + +[pgn_specification]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md +[pgn_formal_syntax]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#18-formal-syntax +[pgn_seven_tag_roster]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md%23811-seven-tag-roster +[pgn_import_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#31-import-format-allows-for-manually-prepared-data +[pgn_export_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#32-export-format-used-for-program-generated-output diff --git a/docs/nips/65.md b/docs/nips/65.md new file mode 100644 index 00000000..36f0d122 --- /dev/null +++ b/docs/nips/65.md @@ -0,0 +1,43 @@ +NIP-65 +====== + +Relay List Metadata +------------------- + +`draft` `optional` + +Defines a replaceable event using `kind:10002` to advertise relays where the user generally **writes** to and relays where the user generally **reads** mentions. + +The event MUST include a list of `r` tags with relay URLs as value and an optional `read` or `write` marker. If the marker is omitted, the relay is both **read** and **write**. + +```jsonc +{ + "kind": 10002, + "tags": [ + ["r", "wss://alicerelay.example.com"], + ["r", "wss://brando-relay.com"], + ["r", "wss://expensive-relay.example2.com", "write"], + ["r", "wss://nostr-relay.example.com", "read"] + ], + "content": "", + // other fields... +} +``` + +When downloading events **from** a user, clients SHOULD use the **write** relays of that user. + +When downloading events **about** a user, where the user was tagged (mentioned), clients SHOULD use the user's **read** relays. + +When publishing an event, clients SHOULD: + +- Send the event to the **write** relays of the author +- Send the event to all **read** relays of each tagged user +- Send the author's `kind:10002` event to all relays the event was published to + +### Size + +Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays of each category). + +### Discoverability + +Clients SHOULD spread an author's `kind:10002` event to as many relays as viable, paying attention to relays that, at any moment, serve naturally as well-known public indexers for these relay lists (where most other clients and users are connecting to in order to publish and fetch those). diff --git a/docs/nips/66.md b/docs/nips/66.md new file mode 100644 index 00000000..59ac1a2e --- /dev/null +++ b/docs/nips/66.md @@ -0,0 +1,97 @@ +NIP-66 +====== + +Relay Discovery and Liveness Monitoring +------------------- + +`draft` `optional` + +This NIP defines events for relay discovery and the announcement of relay monitors. + +## Relay Discovery Events + +`30166` relay discovery events document relay characteristics inferred either from a relay's [NIP 11](https://github.com/nostr-protocol/nips/blob/master/11.md) document, or via probing. + +Information corresponding to field in a relay's NIP 11 document MAY contradict actual values if monitors find that a different policy is implemented than is advertised. + +`content` MAY include the stringified JSON of the relay's NIP-11 informational document. + +The only required tag is the `d` tag, which MUST be set to the relay's [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6) URL. For relays not accessible via URL, a hex-encoded pubkey MAY be used instead. + +Other tags include: + +- `rtt-open` - The relay's open round-trip time in milliseconds. +- `rtt-read` - The relay's read round-trip time in milliseconds. +- `rtt-write` - The relay's write round-trip time in milliseconds. +- `n` - The relay's network type. SHOULD be one of `clearnet`, `tor`, `i2p`, `loki` +- `T` - The relay type. Enumerated [relay type](https://github.com/nostr-protocol/nips/issues/1282) formatted as `PascalCase`, e.g. `PrivateInbox` +- `N` - NIPs supported by the relay +- `R` - Keys corresponding to requirements per [NIP 11](https://github.com/nostr-protocol/nips/blob/master/11.md)'s `limitations` array, including `auth`, `writes`, `pow`, and `payment`. False values should be specified using a `!` prefix, for example `!auth`. +- `t` - A topic associated with this relay +- `k` - Accepted and unaccepted kinds (false values prepended by `!`) +- `g` - A [NIP-52](https://github.com/nostr-protocol/nips/blob/master/52.md) geohash + +Tags with more than one value should be repeated, rather than putting all values in a single tag, for example `[["t", "cats"], ["t", "dogs"]]`, rather than `[["t", "cats", "dogs"]]`. + +Example: + +```json +{ + "id": "<eventid>", + "pubkey": "<monitor's pubkey>", + "created_at": "<created_at [some recent date ...]>", + "signature": "<signature>", + "content": "<optional nip 11 document>", + "kind": 30166, + "tags": [ + ["d","wss://some.relay/"], + ["n", "clearnet"], + ["N", "40"], + ["N", "33"], + ["R", "!payment"], + ["R", "auth"], + ["g", "ww8p1r4t8"], + ["l", "en", "ISO-639-1"], + ["t", "nsfw" ], + ["rtt-open", "234" ] + ] +} +``` + +## Relay Monitor Announcements + +Kind `10166` relay monitor announcements advertise the author's intent to publish `30166` events. This event is optional and is intended for monitors who intend to provide monitoring services at a regular and predictable frequency. + +Tags include: + +- `frequency` - The frequency in seconds at which the monitor publishes events. +- `timeout` (optional) - The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests. +- `c` - a lowercase string describing the checks conducted by a monitor. Examples include `open`, `read`, `write`, `auth`, `nip11`, `dns`, and `geo`. +- `g` - [NIP-52](https://github.com/nostr-protocol/nips/blob/master/11.md) geohash tag + +Monitors SHOULD also publish a `kind 0` profile and a `kind 10002` relay selections event. + +Example: + +```json +{ + "id": "<eventid>", + "pubkey": "<monitor's pubkey>", + "created_at": "<created_at [some recent date ...]>", + "signature": "<signature>", + "content": "", + "tags": [ + [ "timeout", "open", "5000" ], + [ "timeout", "read", "3000" ], + [ "timeout", "write", "3000" ], + [ "timeout", "nip11", "3000" ], + [ "frequency", "3600" ], + [ "c", "ws" ], + [ "c", "nip11" ], + [ "c", "ssl" ], + [ "c", "dns" ], + [ "c", "geo" ] + [ "g", "ww8p1r4t8" ] + ] +} +``` diff --git a/docs/nips/68.md b/docs/nips/68.md new file mode 100644 index 00000000..918378a9 --- /dev/null +++ b/docs/nips/68.md @@ -0,0 +1,92 @@ +NIP-68 +====== + +Picture-first feeds +------------------- + +`draft` `optional` + +This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags. + +The idea is for this type of event to cater to Nostr clients resembling platforms like Instagram, Flickr, Snapchat, or 9GAG, where the picture itself takes center stage in the user experience. + +## Picture Events + +Picture events contain a `title` tag and description in the `.content`. + +They may contain multiple images to be displayed as a single post. + +```jsonc +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <Unix timestamp in seconds>, + "kind": 20, + "content": "<description of post>", + "tags": [ + ["title", "<short title of post>"], + + // Picture Data + [ + "imeta", + "url https://nostr.build/i/my-image.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt A scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt1.jpg", + "fallback https://void.cat/alt1.jpg" + ], + [ + "imeta", + "url https://nostr.build/i/my-image2.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt Another scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt2.jpg", + "fallback https://void.cat/alt2.jpg", + + "annotate-user <32-bytes hex of a pubkey>:<posX>:<posY>" // Tag users in specific locations in the picture + ], + + ["content-warning", "<reason>"], // if NSFW + + // Tagged users + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // Specify the media type for filters to allow clients to filter by supported kinds + ["m", "image/jpeg"], + + // Hashes of each image to make them queryable + ["x", "<sha256>"] + + // Hashtags + ["t", "<tag>"], + ["t", "<tag>"], + + // location + ["location", "<location>"], // city name, state, country + ["g", "<geohash>"], + + // When text is written in the image, add the tag to represent the language + ["L", "ISO-639-1"], + ["l", "en", "ISO-639-1"] + ] +} +``` + +The `imeta` tag `annotate-user` places a user link in the specific position in the image. + +Only the following media types are accepted: +- `image/apng`: Animated Portable Network Graphics (APNG) +- `image/avif`: AV1 Image File Format (AVIF) +- `image/gif`: Graphics Interchange Format (GIF) +- `image/jpeg`: Joint Photographic Expert Group image (JPEG) +- `image/png`: Portable Network Graphics (PNG) +- `image/webp`: Web Picture format (WEBP) + +Picture events might be used with [NIP-71](71.md)'s kind `22` to display short vertical videos in the same feed. diff --git a/docs/nips/69.md b/docs/nips/69.md new file mode 100644 index 00000000..8a28331f --- /dev/null +++ b/docs/nips/69.md @@ -0,0 +1,89 @@ +NIP-69 +====== + +Peer-to-peer Order events +------------------------- + +`draft` `optional` + +## Abstract + +Peer-to-peer (P2P) platforms have seen an upturn in recent years, while having more and more options is positive, in the specific case of p2p, having several options contributes to the liquidity split, meaning sometimes there's not enough assets available for trading. If we combine all these individual solutions into one big pool of orders, it will make them much more competitive compared to centralized systems, where a single authority controls the liquidity. + +This NIP defines a simple standard for peer-to-peer order events, which enables the creation of a big liquidity pool for all p2p platforms participating. + +## The event + +Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2p event look like this: + +```json +{ + "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", + "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", + "created_at": 1702548701, + "kind": 38383, + "tags": [ + ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], + ["k", "sell"], + ["f", "VES"], + ["s", "pending"], + ["amt", "0"], + ["fa", "100"], + ["pm", "face to face", "bank transfer"], + ["premium", "1"], + [ + "rating", + "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" + ], + ["source", "https://t.me/p2plightning/xxxxxxx"], + ["network", "mainnet"], + ["layer", "lightning"], + ["name", "Nakamoto"], + ["g", "<geohash>"], + ["bond", "0"], + ["expiration", "1719391096"], + ["y", "lnp2pbot"], + ["z", "order"] + ], + "content": "", + "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" +} +``` + +## Tags + +- `d` < Order ID >: A unique identifier for the order. +- `k` < Order type >: `sell` or `buy`. +- `f` < Currency >: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. +- `s` < Status >: `pending`, `canceled`, `in-progress`, `success`. +- `amt` < Amount >: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. +- `fa` < Fiat amount >: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. +- `pm` < Payment method >: The payment method used for the trade, if the order has multiple payment methods, they should be separated by a comma. +- `premium` < Premium >: The percentage of the premium the maker is willing to pay. +- `source` [Source]: The source of the order, it can be a URL that redirects to the order. +- `rating` [Rating]: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. +- `network` < Network >: The network used for the trade, it can be `mainnet`, `testnet`, `signet`, etc. +- `layer` < Layer >: The layer used for the trade, it can be `onchain`, `lightning`, `liquid`, etc. +- `name` [Name]: The name of the maker. +- `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. +- `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. +- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](40.md)). +- `y` < Platform >: The platform that created the order. +- `z` < Document >: `order`. + +Mandatory tags are enclosed with `<tag>`, optional tags are enclosed with `[tag]`. + +## Implementations + +Currently implemented on the following platforms: + +- [Mostro](https://github.com/MostroP2P/mostro) +- [@lnp2pBot](https://github.com/lnp2pBot/bot) +- [Robosats](https://github.com/RoboSats/robosats/pull/1362) +- [Peach Bitcoin](https://github.com/Peach2Peach/peach-nostr-announcer-bot) + +## References + +- [Mostro protocol specification](https://mostro.network/protocol/) +- [Messages specification for peer 2 peer NIP proposal](https://github.com/nostr-protocol/nips/blob/8250274a22f4882f621510df0054fd6167c10c9e/31001.md) +- [n3xB](https://github.com/nobu-maeda/n3xb) diff --git a/docs/nips/70.md b/docs/nips/70.md new file mode 100644 index 00000000..043d5fbf --- /dev/null +++ b/docs/nips/70.md @@ -0,0 +1,45 @@ +NIP-70 +====== + +Protected Events +---------------- + +`draft` `optional` + +When the `"-"` tag is present, that means the event is "protected". + +A protected event is an event that can only be published to relays by its author. This is achieved by relays ensuring that the author is [authenticated](42.md) before publishing their own events or by just rejecting events with `["-"]` outright. + +The default behavior of a relay MUST be to reject any event that contains `["-"]`. + +Relays that want to accept such events MUST first require that the client perform the [NIP-42](42.md) `AUTH` flow and then check if the authenticated client has the same pubkey as the event being published and only accept the event in that case. + +## The tag + +The tag is a simple tag with a single item: `["-"]`. It may be added to any event. + +## Example flow + +- User `79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798` connects to relay `wss://example.com`: + +```jsonc +/* client: */ +["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] +/* relay: */ +["AUTH", "<challenge>"] +["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", false, "auth-required: this event may only be published by its author"] +/* client: */ +["AUTH", {}] +["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] +["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", true, ""] +``` + +## Why + +There are multiple circumstances in which it would be beneficial to prevent the unlimited spreading of an event through all relays imaginable and restrict some to only a certain demographic or to a semi-closed community relay. Even when the information is public it may make sense to keep it compartimentalized across different relays. + +It's also possible to create closed access feeds with this when the publisher has some relationship with the relay and trusts the relay to not release their published events to anyone. + +Even though it's ultimately impossible to restrict the spread of information on the internet (for example, one of the members of the closed group may want to take an event intended to be restricted and republish it to other relays), most relays would be happy to not facilitate the acts of these so-called "pirates", in respect to the original decision of the author and therefore gladly reject these republish acts if given the means to. + +This NIP gives these authors and relays the means to clearly signal when a given event is not intended to be republished by third parties. diff --git a/docs/nips/71.md b/docs/nips/71.md new file mode 100644 index 00000000..303ec5a3 --- /dev/null +++ b/docs/nips/71.md @@ -0,0 +1,137 @@ +NIP-71 +====== + +Video Events +------------ + +`draft` `optional` + +This specification defines _video_ events representing a dedicated post of externally hosted content. + +Unlike a `kind:1` event with a video attached, video events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience. + +## Video Events + +There are two types of video events represented by different kinds: _normal_ and _short_ video events. This is meant to allow clients to cater to each as the viewing experience for longer, mostly horizontal (landscape) videos is often different than that of short-form, mostly vertical (portrait), videos ("stories", "reels", "shorts" etc). + +Nothing except cavaliership and common sense prevents a _short_ video from being long, or a _normal_ video from being vertical, and that may or may not be justified, it's mostly a stylistic qualitative difference, not a question of actual raw size. + +#### Format + +The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos. + +The `.content` of these events is a summary or description on the video content. + +The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md) + +Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties. + +This NIP defines the following additional `imeta` properties aside form those listen in [NIP-92](92.md) & [NIP-94](94.md): + +* `duration` (recommended) the duration of the video/audio in seconds (floating point number) +* `bitrate` (recommended) the average bitrate of the video/audio in bits/sec + +Example: +```json +[ + ["imeta", + "dim 1920x1080", + "url https://myvideo.com/1080/12345.mp4", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", + "m video/mp4", + "image https://myvideo.com/1080/12345.jpg", + "image https://myotherserver.com/1080/12345.jpg", + "fallback https://myotherserver.com/1080/12345.mp4", + "fallback https://andanotherserver.com/1080/12345.mp4", + "service nip96", + "bitrate 3000000", + "duration 29.223" + ], + ["imeta", + "dim 1280x720", + "url https://myvideo.com/720/12345.mp4", + "x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d", + "m video/mp4", + "image https://myvideo.com/720/12345.jpg", + "image https://myotherserver.com/720/12345.jpg", + "fallback https://myotherserver.com/720/12345.mp4", + "fallback https://andanotherserver.com/720/12345.mp4", + "service nip96", + "bitrate 2000000", + "duration 29.24" + ], + ["imeta", + "dim 1280x720", + "url https://myvideo.com/720/12345.m3u8", + "x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f", + "m application/x-mpegURL", + "image https://myvideo.com/720/12345.jpg", + "image https://myotherserver.com/720/12345.jpg", + "fallback https://myotherserver.com/720/12345.m3u8", + "fallback https://andanotherserver.com/720/12345.m3u8", + "service nip96", + "duration 29.21" + ], +] +``` + +Where `url` is the primary server url and `fallback` are other servers hosting the same file, both `url` and `fallback` should be weighted equally and clients are recommended to use any of the provided video urls. + +The `image` tag contains a preview image (at the same resolution). Multiple `image` tags may be used to specify fallback copies in the same way `fallback` is used for `url`. + +Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash. + +### Other tags: +* `title` (required) title of the video +* `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published +* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code +* `content-warning` (optional) warning about content of NSFW video +* `alt` (optional) description for accessibility +* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url +* `t` (optional, repeated) hashtag to categorize video +* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL +* `r` (optional, repeated) references / links to web pages + +```jsonc +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": <Unix timestamp in seconds>, + "kind": 21 | 22, + "content": "<summary / description of video>", + "tags": [ + ["title", "<title of video>"], + ["published_at", "<unix timestamp>"], + ["alt", "<description>"], + + // video Data + ["imeta", + "dim 1920x1080", + "url https://myvideo.com/1080/12345.mp4", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", + "m video/mp4", + "image https://myvideo.com/1080/12345.jpg", + "image https://myotherserver.com/1080/12345.jpg", + "fallback https://myotherserver.com/1080/12345.mp4", + "fallback https://andanotherserver.com/1080/12345.mp4", + "service nip96", + ], + + ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], + ["content-warning", "<reason>"], + ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], + + // participants + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // hashtags + ["t", "<tag>"], + ["t", "<tag>"], + + // reference links + ["r", "<url>"], + ["r", "<url>"] + ] +} +``` diff --git a/docs/nips/72.md b/docs/nips/72.md new file mode 100644 index 00000000..9471cdb0 --- /dev/null +++ b/docs/nips/72.md @@ -0,0 +1,132 @@ +NIP-72 +====== + +Moderated Communities (Reddit Style) +------------------------------------ + +`draft` `optional` + +The goal of this NIP is to enable public communities. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag. Moderators may issue an approval event `kind:4550`. + +## Community Definition + +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. A community definition event's `d` tag MAY double as its name, but if a `name` tag is provided, it SHOULD be displayed instead of the `d` tag. + +```jsonc +{ + "created_at": <Unix timestamp in seconds>, + "kind": 34550, + "tags": [ + ["d", "<community-d-identifier>"], + ["name", "<Community name>"], + ["description", "<Community description>"], + ["image", "<Community image url>", "<Width>x<Height>"], + + //.. other tags relevant to defining the community + + // moderators + ["p", "<32-bytes hex of a pubkey1>", "<optional recommended relay URL>", "moderator"], + ["p", "<32-bytes hex of a pubkey2>", "<optional recommended relay URL>", "moderator"], + ["p", "<32-bytes hex of a pubkey3>", "<optional recommended relay URL>", "moderator"], + + // relays used by the community (w/optional marker) + ["relay", "<relay hosting author kind 0>", "author"], + ["relay", "<relay where to send and receive requests>", "requests"], + ["relay", "<relay where to send and receive approvals>", "approvals"], + ["relay", "<relay where to post requests to and fetch approvals from>"] + ], + // other fields... +} +``` + +## Posting to a community + +[NIP-22](NIP-22) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition. + +### Top-level posts + +For top-level posts, the uppercase and lowercase NIP-22 tags should both refer to the community definition itself. + +```jsonc +{ + "kind": 1111, + "tags": [ + ["A", "34550:<community-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["a", "34550:<community-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["P", "<community-author-pubkey>", "<optional-relay-url>"], + ["p", "<community-author-pubkey>", "<optional-relay-url>"], + ["K", "34550"], + ["k", "34550"], + ], + "content": "Hi everyone. It's great to be here!", + // other fields... +} +``` + +### Nested replies + +For nested replies, the uppercase tags should still refer to the community definition, while the lowercase tags should refer to the parent post or reply. + +```jsonc +{ + "kind": 1111, + "tags": [ + // community definition itself + ["A", "34550:<community-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["P", "<community-author-pubkey>", "<optional-relay-url>"], + ["K", "34550"], + + // parent post or reply + ["e", "<parent-event-id>", "<optional-relay-url>"], + ["p", "<parent-event-author-pubkey>", "<optional-relay-url>"], + ["k", "<parent-event-kind>"] // most likely "1111" + ], + "content": "Agreed! Welcome everyone!", + // other fields... +} +``` + +### Backwards compatibility note + +Previously kind 1 events were used for posts in communities, with an "a" tag pointing to the community. For backwards compatibility, clients MAY still query for kind 1 events, but SHOULD NOT use them for new posts. Instead, clients SHOULD use kind 1111 events with the `A` and `a` tags as described above. + +## Moderation + +Anyone may issue an approval event to express their opinion that a post is appropriate for a community. Clients MAY choose which approval events to honor, but SHOULD at least use ones published by the group's defined moderators. + +An approval event MUST include one or more community `a` tags, an `e` or `a` tag pointing to the post, and the `p` tag of the author of the post (for approval notifications). `a` tag prefixes can be used to disambiguate between community and replaceable event pointers (community `a` tags always begin with `34550`). + +The event SHOULD also include the JSON-stringified `post request` event inside the `.content`, and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. + +Moderators MAY request deletion of their approval of a post at any time using [NIP-09 event deletion requests](09.md). + +```jsonc +{ + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "kind": 4550, + "tags": [ + ["a", "34550:<event-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["e", "<post-id>", "<optional-relay-url>"], + ["p", "<port-author-pubkey>", "<optional-relay-url>"], + ["k", "<post-request-kind>"] + ], + "content": "<the full approved event, JSON-encoded>", + // other fields... +} +``` + +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. + +Approvals of replaceable events can be created in three ways: + +1. By tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the replaceable event +2. By tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and +3. By tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. + +Since relays are instructed to delete old versions of a replaceable event, the `content` of an approval using an `e` tag MUST have the specific version of the event or clients might not be able to find that version of the content anywhere. + +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be approved for all `34550:*` `a` tags. + +## Cross-posting + +Clients MAY support cross-posting between communities by posting a NIP 18 `kind 6` or `kind 16` repost to one or more communities using `a` tags as described above. The `content` of the repost MUST be the original event, not the approval event. diff --git a/docs/nips/73.md b/docs/nips/73.md new file mode 100644 index 00000000..7fb9a3c3 --- /dev/null +++ b/docs/nips/73.md @@ -0,0 +1,128 @@ +NIP-73 +====== + +External Content IDs +-------------------- + +`draft` `optional` + +There are certain established global content identifiers such as [Book ISBNs](https://en.wikipedia.org/wiki/ISBN), [Podcast GUIDs](https://podcastnamespace.org/tag/guid), and [Movie ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) that are useful to reference in nostr events so that clients can query all the events associated with these ids. + + +`i` tags are used for referencing these external content ids, with `k` tags representing the external content id kind so that clients can query all the events for a specific kind. + +## Supported IDs + +| Type | `i` tag | `k` tag | +| --- | --- | --- | +| URLs | "`<URL, normalized, no fragment>`" | "web" | +| Books | "isbn:`<id, without hyphens>`" | "isbn" | +| Geohashes | "geo:`<geohash, lowercase>`" | "geo" | +| Movies | "isan:`<id, without version part>`" | "isan" | +| Papers | "doi:`<id, lowercase>`" | "doi" | +| Hashtags | "#`<topic, lowercase>`" | "#" | +| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | +| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | +| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | +| Blockchain Transaction | "`<blockchain>`:[`<chainId>`:]tx:`<txid, hex, lowercase>`" | "`<blockchain>`:tx" | +| Blockchain Address | "`<blockchain>`:[`<chainId>`:]address:`<address>`" | "`<blockchain>`:address" | + +--- + +## Examples + + +### Webpages + +For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" and "k" tags are: + +```jsonc +[ + ["i", "https://myblog.example.com/post/2012-03-27/hello-world"], + ["k", "web"] +] +``` + +### Books: + +- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 + +Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs return the ISBNs without hyphens. Removing hyphens from ISBNs is trivial, whereas adding the hyphens back in is non-trivial requiring a library. + +### Podcasts: + +- Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc +- Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]` +- Podcast RSS Publisher GUID: `["i", "podcast:publisher:guid:18bcbf10-6701-4ffb-b255-bc057390d738"]` + +### Movies: + +- Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 + +Movie ISANs SHOULD be referenced _**without the version part**_ as the versions / edits of movies are not relevant. More info on ISAN parts here - https://support.isan.org/hc/en-us/articles/360002783131-Records-relations-and-hierarchies-in-the-ISAN-Registry + +### Blockchain + +`<blockchain>` can be any layer 1 chain (`bitcoin`, `ethereum`, `solana`, ...). If necessary (e.g. for ethereum), you can specify a `<chainId>`. + +#### Bitcoin + +``` +bitcoin:address:<bech32, lowercase | base58, case sensitive> +bitcoin:tx:<txid, hex, lowercase> +``` + +E.g. https://blockstream.info/tx/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d + +```jsonc +[ + ["i", "bitcoin:tx:a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"], + ["k", "bitcoin:tx"] +] +``` + +E.g. https://blockstream.info/address/1HQ3Go3ggs8pFnXuHVHRytPCq5fGG8Hbhx + +```jsonc +[ + ["i", "bitcoin:address:1HQ3Go3ggs8pFnXuHVHRytPCq5fGG8Hbhx"], + ["k", "bitcoin:address"] +] +``` + +#### Ethereum (and other EVM chains) + +``` +ethereum:<chainId, integer>:tx:<txHash, hex, lowercase> +ethereum:<chainId, integer>:address:<hex, lowercase> +``` + +E.g. https://etherscan.io/address/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 + +```jsonc +[ + ["i", "ethereum:1:address:0xd8da6bf26964af9d7eed9e03e53415d37aa96045"], + ["k", "ethereum:address"] +] +``` + +E.g. https://gnosisscan.io/tx/0x98f7812be496f97f80e2e98d66358d1fc733cf34176a8356d171ea7fbbe97ccd + +```jsonc +[ + ["i", "ethereum:100:tx:0x98f7812be496f97f80e2e98d66358d1fc733cf34176a8356d171ea7fbbe97ccd"], + ["k", "ethereum:tx"] +] +``` + + + +--- + +### Optional URL Hints + +Each `i` tag MAY have a url hint as the second argument to redirect people to a website if the client isn't opinionated about how to interpret the id: + +`["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg]` + +`["i", "isan:0000-0000-401A-0000-7", https://www.imdb.com/title/tt0120737]` diff --git a/docs/nips/75.md b/docs/nips/75.md new file mode 100644 index 00000000..ad933d5f --- /dev/null +++ b/docs/nips/75.md @@ -0,0 +1,85 @@ +NIP-75 +====== + +Zap Goals +--------- + +`draft` `optional` + +This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event. + +## Nostr Event + +A `kind:9041` event is used. + +The `.content` contains a human-readable description of the goal. + +The following tags are defined as REQUIRED. + +- `amount` - target amount in milisats. +- `relays` - a list of relays the zaps to this goal will be sent to and tallied from. + +Example event: + +```jsonc +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/], + ["amount", "210000"], + ], + "content": "Nostrasia travel expenses", + // other fields... +} +``` + +The following tags are OPTIONAL. + +- `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress. +- `image` - an image for the goal +- `summary` - a brief description + +```jsonc +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/], + ["amount", "210000"], + ["closed_at", "<unix timestamp in seconds>"], + ["image", "<image URL>"], + ["summary", "<description of the goal>"], + ], + "content": "Nostrasia travel expenses", + // other fields... +} +``` + +The goal MAY include an `r` or `a` tag linking to a URL or addressable event. + +The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events). + +Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. + +```jsonc +{ + "kind": 3xxxx, + "tags": [ + ["goal", "<event id>", "<Relay URL (optional)>"], + // rest of tags... + ], + // other fields... +} +``` + +## Client behavior + +Clients MAY display funding goals on user profiles. + +When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. + +When zapping an addressable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. + +## Use cases + +- Fundraising clients +- Adding funding goals to events such as long form posts, badges or live streams diff --git a/docs/nips/77.md b/docs/nips/77.md new file mode 100644 index 00000000..dd5ef070 --- /dev/null +++ b/docs/nips/77.md @@ -0,0 +1,175 @@ +NIP-77 +====== + +Negentropy Syncing +------------------ + +`draft` `optional` + +This document describes a protocol extension for syncing events. It works for both client-relay and relay-relay scenarios. If both sides of the sync have events in common, then this protocol will use less bandwidth than transferring the full set of events (or even just their IDs). + +It is a Nostr-friendly wrapper around the [Negentropy](https://github.com/hoytech/negentropy) protocol, which uses a technique called [Range-Based Set Reconciliation](https://logperiodic.com/rbsr.html). + +Since Negentropy is a binary protocol, this wrapper hex-encodes its messages. The specification for Negentropy Protocol V1 is attached as an appendix to this NIP below. + +## High-Level Protocol Description + +We're going to call the two sides engaged in the sync the client and the relay (even though the initiator could be another relay instead of a client). + +* (1) Client (initiator) chooses a filter, and retrieves the set of events that it has locally that match this filter (or uses a cache), and constructs an initial message. +* (2) Client sends a `NEG-OPEN` message to the relay, which includes the filter and the initial message. +* (3) Relay selects the set of events that it has locally that match the filter (or uses a cache). +* (4) Relay constructs a response and returns it to the client in a `NEG-MSG` message. +* (5) Client parses the message to learn about IDs it has (and relay needs) and IDs it needs (and relay has). + * If client wishes to continue, then it constructs a new message and sends it to the relay in a `NEG-MSG` message. Goto step 4. + * If client wishes to stop, then it sends a `NEG-CLOSE` message or disconnects the websocket. + +The above protocol only results in the client learning about IDs it has/needs, and does not actually transfer events. Given these IDs, the client can upload events it has with `EVENT`, and/or download events it needs with `REQ`. This can be performed over the same websocket connection in parallel with subsequent `NEG-MSG` messages. If a client is only interested in determining the number of unique events (ie, reaction counts), it may choose to not download/upload at all. + +## Nostr Messages + +### Initial message (client to relay): + +```jsonc +[ + "NEG-OPEN", + <subscription ID string>, + <filter>, + <initialMessage, hex-encoded> +] +``` + +* The subscription ID is used by each side to identify which query a message refers to. It only needs to be long enough to distinguish it from any other concurrent subscriptions on this websocket connection (an integer that increments once per `NEG-OPEN` is fine). Subscription IDs are in a separate namespace from `REQ` subscription IDs. If a `NEG-OPEN` is issued for a currently open subscription ID, the existing subscription is first closed. +* The filter is as described in [NIP-01](01.md). +* `initialMessage` is the initial Negentropy binary message, hex-encoded. See appendix. + +### Error message (relay to client): + +If a request cannot be serviced by the relay, an error is returned to the client: + +```jsonc +[ + "NEG-ERR", + <subscription ID string>, + <reason code string> +] +``` + +Error reasons are the same format as in NIP-01. They should begin with a machine-readable single-word prefix, followed by a `:` and then a human-readable message with more information. + +The current suggested error reasons are + +* `blocked` + * Relays can optionally reject queries that would require them to process too many records, or records that are too old + * The maximum number of records that can be processed can optionally be returned as the 4th element in the response + * Example: `blocked: this query is too big` +* `closed` + * Because the `NEG-OPEN` queries may be stateful, relays may choose to time-out inactive queries to recover memory resources + * Example: `closed: you took too long to respond!` + +After a `NEG-ERR` is issued, the subscription is considered to be closed. + +### Subsequent messages (bidirectional): + +Relay and client alternate sending each other `NEG-MSG`s: + +```jsonc +[ + "NEG-MSG", + <subscription ID string>, + <message, hex-encoded> +] +``` + +* `message` is a Negentropy binary message, hex-encoded. Both message directions use the same format. See appendix. + +### Close message (client to relay): + +When finished, the client should tell the relay it can release its resources with a `NEG-CLOSE`: + +```jsonc +[ + "NEG-CLOSE", + <subscription ID string> +] +``` + + +## Appendix: Negentropy Protocol V1 + +### Preparation + +There are two protocol participants: Client and server. The client creates an initial message and transmits it to the server, which replies with its own message in response. The client continues querying the server until it is satisfied, and then terminates the protocol. Messages in either direction have the same format. + +Each participant has a collection of records. A records consists of a 64-bit numeric timestamp and a 256-bit ID. Each participant starts by sorting their items according to timestamp, ascending. If two timestamps are equal then items are sorted lexically by ID, ascending by first differing byte. Items may not use the max uint64 value (`2**64 - 1`) as a timestamp since this is reserved as a special "infinity" value. + +The goal of the protocol is for the client to learn the set of IDs that it has and the server does not, and the set of items that the server has and it does not. + +### `Varint` + +Varints (variable-sized unsigned integers) are represented as base-128 digits, most significant digit first, with as few digits as possible. Bit eight (the high bit) is set on each byte except the last. + + Varint := <Digit+128>* <Digit> + +### `Id` + +IDs are represented as byte-strings of length `32`: + + Id := Byte{32} + +### `Message` + +A reconciliation message is a protocol version byte followed by an ordered list of ranges: + + Message := <protocolVersion (Byte)> <Range>* + +The current protocol version is 1, represented by the byte `0x61`. Protocol version 2 will be `0x62`, and so forth. If a server receives a message with a protocol version that it cannot handle, it should reply with a single byte containing the highest protocol version it supports, allowing the client to downgrade and retry its message. + +Each Range corresponds to a contiguous section of the timestamp/ID space. The first Range starts at timestamp 0 and an ID of 0 bytes. Ranges are always adjacent (no gaps). If the last Range doesn't end at the special infinity value, an implicit `Skip` to infinity Range is appended. This means that the list of Ranges always covers the full timestamp/ID space. + +### `Range` + +A Range consists of an upper bound, a mode, and a payload: + + Range := <upperBound (Bound)> <mode (Varint)> <payload (Skip | Fingerprint | IdList)> + +The contents of the payload is determined by mode: + +* If `mode = 0`, then payload is `Skip`, meaning the sender does not wish to process this Range further. This payload is empty: + + Skip := + +* If `mode = 1`, then payload is a `Fingerprint`, which is a [digest](#fingerprint-algorithm) of all the IDs the sender has within the Range: + + Fingerprint := Byte{16} + +* If `mode = 2`, the payload is `IdList`, a variable-length list of all IDs the sender has within the Range: + + IdList := <length (Varint)> <ids (Id)>* + + +### `Bound` + +Each Range is specified by an *inclusive* lower bound and an *exclusive* upper bound. As defined above, each Range only includes an upper bound: the lower bound of a Range is the upper bound of the previous Range, or 0 timestamp/0 ID for the first Range. + +A Bound consists of an encoded timestamp and a variable-length disambiguating prefix of an ID (in case multiple items have the same timestamp): + + Bound := <encodedTimestamp (Varint)> <length (Varint)> <idPrefix (Byte)>* + +* The timestamp is encoded specially. The infinity timestamp is encoded as `0`. All other values are encoded as `1 + offset`, where offset is the difference between this timestamp and the previously encoded timestamp. The initial offset starts at `0` and resets at the beginning of each message. + + Offsets are always non-negative since the upper bound's timestamp is greater than or equal to the lower bound's timestamp, ranges in a message are always encoded in ascending order, and ranges never overlap. + +* The size of `idPrefix` is encoded in `length`, and can be between `0` and `32` bytes, inclusive. This allows implementations to use the shortest possible prefix to separate the first record of this Range from the last record of the previous Range. If these records' timestamps differ, then the length should be 0, otherwise it should be the byte-length of their common ID-prefix plus 1. + + If the `idPrefix` length is less than `32` then the omitted trailing bytes are implicitly 0 bytes. + + +### Fingerprint Algorithm + +The fingerprint of a Range is computed with the following algorithm: + +* Compute the addition mod 2<sup>256</sup> of the element IDs (interpreted as 32-byte little-endian unsigned integers) +* Concatenate with the number of elements in the Range, encoded as a [Varint](#varint) +* Hash with SHA-256 +* Take the first 16 bytes diff --git a/docs/nips/78.md b/docs/nips/78.md new file mode 100644 index 00000000..abdd1b21 --- /dev/null +++ b/docs/nips/78.md @@ -0,0 +1,21 @@ +NIP-78 +====== + +Arbitrary custom app data +------------------------- + +`draft` `optional` + +The goal of this NIP is to enable [remoteStorage](https://remotestorage.io/)-like capabilities for custom applications that do not care about interoperability. + +Even though interoperability is great, some apps do not want or do not need interoperability, and it wouldn't make sense for them. Yet Nostr can still serve as a generalized data storage for these apps in a "bring your own database" way, for example: a user would open an app and somehow input their preferred relay for storage, which would then enable these apps to store application-specific data there. + +## Nostr event + +This NIP specifies the use of event kind `30078` (an _addressable_ event) with a `d` tag containing some reference to the app name and context -- or any other arbitrary string. `content` and other `tags` can be anything or in any format. + +## Some use cases + + - User personal settings on Nostr clients (and other apps unrelated to Nostr) + - A way for client developers to propagate dynamic parameters to users without these having to update + - Personal private data generated by apps that have nothing to do with Nostr, but allow users to use Nostr relays as their personal database diff --git a/docs/nips/7D.md b/docs/nips/7D.md new file mode 100644 index 00000000..fb1b7188 --- /dev/null +++ b/docs/nips/7D.md @@ -0,0 +1,33 @@ +NIP-7D +====== + +Threads +------- + +`draft` `optional` + +A thread is a `kind 11` event. Threads SHOULD include a `title`. + +```json +{ + "kind": 11, + "content": "Good morning", + "tags": [ + ["title", "GM"] + ] +} +``` + +Replies to `kind 11` MUST use [NIP-22](./22.md) `kind 1111` comments. Replies should +always be to the root `kind 11` to avoid arbitrarily nested reply hierarchies. + +```json +{ + "kind": 1111, + "content": "Cool beans", + "tags": [ + ["K", "11"], + ["E", <event-id>, <relay-url>, <pubkey>] + ] +} +``` diff --git a/docs/nips/84.md b/docs/nips/84.md new file mode 100644 index 00000000..1094f555 --- /dev/null +++ b/docs/nips/84.md @@ -0,0 +1,51 @@ +NIP-84 +====== + +Highlights +---------- + +`draft` `optional` + +This NIP defines `kind:9802`, a "highlight" event, to signal content a user finds valuable. + +## Format +The `.content` of these events is the highlighted portion of the text. + +`.content` might be empty for highlights of non-text based media (e.g. NIP-94 audio/video). + +### References +Events SHOULD tag the source of the highlight, whether nostr-native or not. +`a` or `e` tags should be used for nostr events and `r` tags for URLs. + +When tagging a URL, clients generating these events SHOULD do a best effort of cleaning the URL from trackers +or obvious non-useful information from the query string. + +### Attribution +Clients MAY include one or more `p` tags, tagging the original authors of the material being highlighted; this is particularly +useful when highlighting non-nostr content for which the client might be able to get a nostr pubkey somehow +(e.g. prompting the user or reading a `<link rel="me" href="nostr:nprofile1..." />` tag on the document). A role MAY be included as the +last value of the tag. + +```jsonc +{ + "tags": [ + ["p", "<pubkey-hex>", "<relay-url>", "author"], + ["p", "<pubkey-hex>", "<relay-url>", "author"], + ["p", "<pubkey-hex>", "<relay-url>", "editor"] + ], + // other fields... +} +``` + +### Context +Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the +surrounding content might be beneficial to give context to the highlight. + +## Quote Highlights +A `comment` tag may be added to create a quote highlight. This MUST be rendered like a quote repost with the highlight as the quoted note. + +This is to prevent the creation and multiple notes (highlight + kind 1) for a single highlight action, which looks bad in micro-blogging clients where these notes may appear in succession. + +p-tag mentions MUST have a `mention` attribute to distinguish it from authors and editors. + +r-tag urls from the comment MUST have a `mention` attribute to distinguish from the highlighted source url. The source url MUST have the `source` attribute. diff --git a/docs/nips/86.md b/docs/nips/86.md new file mode 100644 index 00000000..6f64eee7 --- /dev/null +++ b/docs/nips/86.md @@ -0,0 +1,90 @@ +NIP-86 +====== + +Relay Management API +-------------------- + +`draft` `optional` + +Relays may provide an API for performing management tasks. This is made available as a JSON-RPC-like request-response protocol over HTTP, on the same URI as the relay's websocket. + +When a relay receives an HTTP(s) request with a `Content-Type` header of `application/nostr+json+rpc` to a URI supporting WebSocket upgrades, it should parse the request as a JSON document with the following fields: + +```json +{ + "method": "<method-name>", + "params": ["<array>", "<of>", "<parameters>"] +} +``` + +Then it should return a response in the format + +```json +{ + "result": {"<arbitrary>": "<value>"}, + "error": "<optional error message, if the call has errored>" +} +``` + +This is the list of **methods** that may be supported: + +* `supportedmethods`: + - params: `[]` + - result: `["<method-name>", "<method-name>", ...]` (an array with the names of all the other supported methods) +* `banpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listbannedpubkeys`: + - params: `[]` + - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `allowpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listallowedpubkeys`: + - params: `[]` + - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `listeventsneedingmoderation`: + - params: `[]` + - result: `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}]`, an array of objects +* `allowevent`: + - params: `["<32-byte-hex-event-id>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `banevent`: + - params: `["<32-byte-hex-event-id>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listbannedevents`: + - params: `[]` + - result: `[{"id": "<32-byte hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `changerelayname`: + - params: `["<new-name>"]` + - result: `true` (a boolean always set to `true`) +* `changerelaydescription`: + - params: `["<new-description>"]` + - result: `true` (a boolean always set to `true`) +* `changerelayicon`: + - params: `["<new-icon-url>"]` + - result: `true` (a boolean always set to `true`) +* `allowkind`: + - params: `[<kind-number>]` + - result: `true` (a boolean always set to `true`) +* `disallowkind`: + - params: `[<kind-number>]` + - result: `true` (a boolean always set to `true`) +* `listallowedkinds`: + - params: `[]` + - result: `[<kind-number>, ...]`, an array of numbers +* `blockip`: + - params: `["<ip-address>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `unblockip`: + - params: `["<ip-address>"]` + - result: `true` (a boolean always set to `true`) +* `listblockedips`: + - params: `[]` + - result: `[{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...]`, an array of objects + +### Authorization + +The request must contain an `Authorization` header with a valid [NIP-98](./98.md) event, except the `payload` tag is required. The `u` tag is the relay URL. + +If `Authorization` is not provided or is invalid, the endpoint should return a 401 response. diff --git a/docs/nips/87.md b/docs/nips/87.md new file mode 100644 index 00000000..00100386 --- /dev/null +++ b/docs/nips/87.md @@ -0,0 +1,142 @@ +NIP-87 +====== + +Ecash Mint Discoverability +-------------------------------- + +`draft` `optional` + +This NIP describes `kind:38173`, `kind:38172` and `kind:38000`: a way to discover ecash mints, their capabilities, and people who recommend them. + +## Rationale + +Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics. +This NIP provides a simple way for users to discover ecash mints recommended by other users and to interact with them. + +### Parties involved + +There are three actors to this workflow: + +* An ecash mint operator, announces their mint and its capabilities. + * Publishes `kind:38173` or `kind:38172`, detailing how to connect to it and its capabilities. +* user A, who recommends an ecash mint + * Publishes `kind:38000` +* user B, who seeks a recommendation for an ecash mint + * Queries for `kind:38000` and, based on results, queries for `kind:38173`/`kind:38172` + +## Events + +### Recommendation event +```json +{ + "kind": 38000, + "pubkey": <recommender-user-pubkey>, + "tags": [ + ["k", "38173"], + ["d", "<d-identifier>"], + ["u", <recommended-fedimint-invite-code>], + ["a", "38173:fedimint-pubkey:<d-identifier>", "wss://relay1"] + ], + "content": "I trust this mint with my life" +} +``` + +The recommendation event is a parameterized-replaceable event so that a user can change edit their recommendation without creating a new event. + +The `d` tag in `kind:38000` is the `kind:38173`/`kind:38172` event identifier this event is recommending, if no event exists, the `d` tag can still be calculated from the mint's pubkey/id. +The `k` tag is the kind number that corresponds to the event kind that the user is recommending, in this case `kind:38173` for fedimints and `kind:38172` for cashu mints. + +Optional `u` tags can be added to give a recommend way to connect to the mint. +The value of the tag is the URL or invite code of the ecash mint. +Multiple `u` tags can appear on the same `kind:38000`. + +`a` tags are used to point to the `kind:38173`/`kind:38172` event of the ecash mint. +The first value of the tag is the `kind:38173`/`kind:38172` event identifier, the second value of the tag is a relay hint. +This is used to correctly point to the mint's `kind:38173`/`kind:38172` event in case there are duplicates claiming to be the same mint. + +The content can be used to give a review. + +## Ecash Mint Information + +Cashu mints SHOULD publish `kind:38172` events to announce their capabilities and how to connect to them. + +For cashu mints, the `u` tag SHOULD be the URL to the cashu mint and it should list the nuts that the cashu mint supports. + +The `d` tag SHOULD be the mint's pubkey (found when querying `/v1/info`), this way users can query by pubkey and find the mint announcement. + +An `n` tag SHOULD be added to signify the network the cashu mint is on (either `mainnet`, `testnet`, `signet`, or `regtest`) + +```json +{ + "kind": 38172, + "pubkey": "<application-pubkey>", + "content": "<optional-kind:0-style-metadata>", + "tags": [ + ["d", <cashu mint pubkey>], + ["u", "https://cashu.example.com"], + ["nuts", "1,2,3,4,5,6,7"], + ["n", "mainnet"] + ] +} +``` + +Fedimints SHOULD publish `kind:38173` events to announce their capabilities and how to connect to them. + +For fedimints, it should list all known fedimint invite codes in `u` tags and it should list the modules it supports. + +The `d` tag SHOULD be the federation id, this way users can query by federation id and find the fedimint announcement. + +An `n` tag SHOULD be added to signify the network the fedimint is on (either `mainnet`, `testnet`, `signet`, or `regtest`) + +```json +{ + "kind": 38173, + "pubkey": "<application-pubkey>", + "content": "<optional-kind:0-style-metadata>", + "tags": [ + ["d", <federation-id>], + ["u", "fed11abc.."], + ["u", "fed11xyz.."], + ["modules", "lightning,wallet,mint"], + ["n", "signet"] + ] +} +``` + +* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:38173` is not a normal user. If `content` is empty, the `kind:0` of the pubkey should be used to display mint information (e.g. name, picture, web, LUD16, etc.) + +## Example + +### User A recommends some mints +User A might be a user of a cashu mint. Using a client, user A publishes an event recommending the cashu mint they use. + +```json +{ + "kind": 38000, + "tags": [ + ["u", "fed11abc..", "fedimint"], + ["u", "https://cashu.example.com", "cashu"], + ["a", "38173:fedimint-pubkey:<d-identifier>", "wss://relay1", "fedimint"], + ["a", "38172:cashu-mint-pubkey:<d-identifier>", "wss://relay2", "cashu"] + ], + ... +} +``` + +### User B finds a mint +User B wants to use an ecash wallet, they need to find a mint. + +User B's wallet client queries for `kind:38000` events, looking for recommendations for ecash mints. + +```json +["REQ", <id>, [{ "kinds": [38000], "authors": [<user>, <users-contact-list>], "#k": ["38173"] }]] +``` + +User B, who follows User A, sees that `kind:38000` event and tries to connect to the corresponding mints. + +### Alternative query bypassing `kind:38000` +Alternatively, users might choose to query directly for `kind:38173` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. + +```json +["REQ", <id>, [{ "kinds": [38173], "authors": [...] }]] +``` diff --git a/docs/nips/88.md b/docs/nips/88.md new file mode 100644 index 00000000..331cd271 --- /dev/null +++ b/docs/nips/88.md @@ -0,0 +1,132 @@ +NIP-88 +====== + +Polls +----- + +`draft` `optional` + +This NIP defines the event scheme that describe Polls on nostr. + +## Events + +### Poll Event + +The poll event is defined as a `kind:1068` event. + +- **content** key holds the label for the poll. + +Major tags in the poll event are: + +- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. +- **relay**: One or multiple tags that the poll is expecting respondents to respond on. +- **polltype**: can be "singlechoice" or "multiplechoice". Polls that do not have a polltype should be considered a "singlechoice" poll. +- **endsAt**: signifying at which unix timestamp the poll is meant to end. + +Example Event + +```json +{ + "content": "Pineapple on pizza", + "created_at": 1719888496, + "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", + "kind": 1068, + "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", + "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", + "tags": [ + ["option", "qj518h583", "Yay"], + ["option", "gga6cdnqj", "Nay"], + ["relay", "<relay url1>"], + ["relay", "<relay url2>"], + ["polltype", "singlechoice"], + ["endsAt", "<unix timestamp in seconds>"] + ] +} +``` + +### Responses + +The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. + +- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. + +The responses are meant to be published to the relays specified in the poll event. + +Example Response Event + +```json +{ + "content": "", + "created_at": 1720097117, + "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", + "kind": 1018, + "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", + "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", + "tags": [ + ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["response", "gga6cdnqj"], + ["response", "m3agjsdq1"] + ] +} +``` + +### Poll Types + +The polltype setting dictates how multiple response tags are handled in the `kind:1018` event. + +- **polltype: singlechoice**: The first response tag is to be considered the actual response. +- **polltype: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. + +### Counting Results + +Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +The results displayed should only be 1 vote event per pubkey. +In case of multiple events for a pubkey, the event with the largest timestamp within the poll limits should be considered. + +Example for querying polls. + +```ts +const fetchVoteEvents = (filterPubkeys: string[]) => { + let resultFilter: Filter = { + "#e": [pollEvent.id], + kinds: [1018], + }; + if (filterPubkeys?.length) { + resultFilter.authors = filterPubkeys; + } + if (pollExpiration) { + resultFilter.until = Number(pollExpiration); + } + pool.subscribeMany(relays, [resultFilter], { + onevent: handleResultEvent, + }); +}; +``` + +Example for maintaining OneVotePerPubkey + +```ts +const oneVotePerPubkey = (events: Event[]) => { + const eventMap = new Map<string, Event>(); + + events.forEach((event) => { + if ( + !eventMap.has(event.pubkey) || + event.created_at > eventMap.get(event.pubkey)!.created_at + ) { + eventMap.set(event.pubkey, event); + } + }); + + return Array.from(eventMap.values()); +}; +``` + +### Relays + +It is advisable for poll authors to use relays that do not allow backdated events and do not honor kind:5 (delete) requests for vote events in order to maintain the integrity of poll results after the poll has ended. + +### Curation + +The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/docs/nips/89.md b/docs/nips/89.md new file mode 100644 index 00000000..dff4ea1d --- /dev/null +++ b/docs/nips/89.md @@ -0,0 +1,133 @@ +NIP-89 +====== + +Recommended Application Handlers +-------------------------------- + +`draft` `optional` + +This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds. + +## Rationale + +Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics. +This NIP provides a simple way for clients to discover applications that handle events of a specific kind to ensure smooth cross-client and cross-kind interactions. + +### Parties involved + +There are three actors to this workflow: + +* application that handles a specific event kind (note that an application doesn't necessarily need to be a distinct entity and it could just be the same pubkey as user A) + * Publishes `kind:31990`, detailing how apps should redirect to it +* user A, who recommends an app that handles a specific event kind + * Publishes `kind:31989` +* user B, who seeks a recommendation for an app that handles a specific event kind + * Queries for `kind:31989` and, based on results, queries for `kind:31990` + +## Events + +### Recommendation event +```jsonc +{ + "kind": 31989, + "pubkey": <recommender-user-pubkey>, + "tags": [ + ["d", <supported-event-kind>], + ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"], + ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"] + ], + // other fields... +} +``` + +The `d` tag in `kind:31989` is the supported event kind this event is recommending. + +Multiple `a` tags can appear on the same `kind:31989`. + +The second value of the tag SHOULD be a relay hint. +The third value of the tag SHOULD be the platform where this recommendation might apply. + +### Handler information +```jsonc +{ + "kind": 31990, + "pubkey": "<application-pubkey>", + "content": "<optional-kind:0-style-metadata>", + "tags": [ + ["d", <random-id>], + ["k", <supported-event-kind>], + ["web", "https://..../a/<bech32>", "nevent"], + ["web", "https://..../p/<bech32>", "nprofile"], + ["web", "https://..../e/<bech32>"], + ["ios", ".../<bech32>"] + ], + // other fields... +} +``` + +* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) +* `k` tags' value is the event kind that is supported by this `kind:31990`. +Using a `k` tag(s) (instead of having the kind of the `d` tag) provides: + * Multiple `k` tags can exist in the same event if the application supports more than one event kind and their handler URLs are the same. + * The same pubkey can have multiple events with different apps that handle the same event kind. +* `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application. + +Multiple tags might be registered by the app, following NIP-19 nomenclature as the second value of the array. + +A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag. + +## Client tag +When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. + +```jsonc +{ + "kind": 1, + "tags": [ + ["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"] + ] + // other fields... +} +``` + +## User flow +A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application. + +When user B sees an unknown event kind, e.g. in a social-media centric nostr client, the client would allow user B to interact with the unknown-kind event (e.g. tapping on it). + +The client MIGHT query for the user's and the user's follows handler. + +## Example + +### User A recommends a `kind:31337`-handler +User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler. + +```jsonc +{ + "kind": 31989, + "tags": [ + ["d", "31337"], + ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"] + ], + // other fields... +} +``` + +### User B interacts with a `kind:31337`-handler +User B might see in their timeline an event referring to a `kind:31337` event (e.g. a `kind:1` tagging a `kind:31337`). + +User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`: + +``` +["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] +``` + +User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. + +User B's client sees the application's `kind:31990` which includes the information to redirect the user to the relevant URL with the desired entity replaced in the URL. + +### Alternative query bypassing `kind:31989` +Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. + +``` +["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] +``` diff --git a/docs/nips/90.md b/docs/nips/90.md new file mode 100644 index 00000000..e39ce904 --- /dev/null +++ b/docs/nips/90.md @@ -0,0 +1,230 @@ +NIP-90 +====== + +Data Vending Machine +-------------------- + +`draft` `optional` + +This NIP defines the interaction between customers and Service Providers for performing on-demand computation. + +Money in, data out. + +## Kinds +This NIP reserves the range `5000-7000` for data vending machine use. + +| Kind | Description | +| ---- | ----------- | +| 5000-5999 | Job request kinds | +| 6000-6999 | Job result | +| 7000 | Job feedback | + +Job results always use a kind number that is `1000` higher than the job request kind. (e.g. request: `kind:5001` gets a result: `kind:6001`). + +Job request types are defined [separately](https://github.com/nostr-protocol/data-vending-machines/tree/master/kinds). + +## Rationale +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. + +This NIP is not to be confused with a 1:1 marketplace; instead, it describes a flow where a user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. + +### Actors +There are two actors in the workflow described in this NIP: +* Customers (npubs who request a job) +* Service providers (npubs who fulfill jobs) + +## Job request (`kind:5000-5999`) +A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute. + +```jsonc +{ + "kind": 5xxx, // kind in 5000-5999 range + "content": "", + "tags": [ + [ "i", "<data>", "<input-type>", "<relay>", "<marker>" ], + [ "output", "<mime-type>" ], + [ "relays", "wss://..." ], + [ "bid", "<msat-amount>" ], + [ "t", "bitcoin" ] + ], + // other fields... +} +``` + +All tags are optional. + +* `i` tag: Input data for the job (zero or more inputs) + * `<data>`: The argument for the input + * `<input-type>`: The way this argument should be interpreted. MUST be one of: + * `url`: A URL to be fetched of the data that should be processed. + * `event`: A Nostr event ID. + * `job`: The output of a previous job with the specified event ID. The dermination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.) + * `text`: `<data>` is the value of the input, no resolution is needed + * `<relay>`: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string + * `<marker>`: An optional field indicating how this input should be used within the context of the job +* `output`: Expected output format. Different job request `kind` defines this more precisely. +* `param`: Optional parameters for the job as key (first argument)/value (second argument). Different job request `kind` defines this more precisely. (e.g. `[ "param", "lang", "es" ]`) +* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay +* `relays`: List of relays where Service Providers SHOULD publish responses to +* `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job + +### Encrypted Params + +If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](04.md), using the user's private and service provider's public key for the shared secret + +```json +[ + ["i", "what is the capital of France? ", "text"], + ["param", "model", "LLaMA-2"], + ["param", "max_tokens", "512"], + ["param", "temperature", "0.5"], + ["param", "top-k", "50"], + ["param", "top-p", "0.7"], + ["param", "frequency_penalty", "1"] +] +``` + +This param data will be encrypted and added to the `content` field and `p` tag should be present + +```jsonc +{ + "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", + "tags": [ + ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], + ["encrypted"] + ], + // other fields... +} +``` + + +## Job result (`kind:6000-6999`) + +Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. + +```jsonc +{ + "pubkey": "<service-provider pubkey>", + "content": "<payload>", + "kind": 6xxx, + "tags": [ + ["request", "<job-request>"], + ["e", "<job-request-id>", "<relay-hint>"], + ["i", "<input-data>"], + ["p", "<customer's-pubkey>"], + ["amount", "requested-payment-amount", "<optional-bolt11>"] + ], + // other fields... +} +``` + +* `request`: The job request event stringified-JSON. +* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. +* `i`: The original input(s) specified in the request. + +### Encrypted Output + +If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text. +Add a tag encrypted to mark the output content as `encrypted` + +```jsonc +{ + "pubkey": "<service-provider pubkey>", + "content": "<encrypted payload>", + "kind": 6xxx, + "tags": [ + ["request", "<job-request>"], + ["e", "<job-request-id>", "<relay-hint>"], + ["p", "<customer's-pubkey>"], + ["amount", "requested-payment-amount", "<optional-bolt11>"], + ["encrypted"] + ], + // other fields... +} +``` + +## Job feedback + +Service providers can give feedback about a job back to the customer. + +```jsonc +{ + "kind": 7000, + "content": "<empty-or-payload>", + "tags": [ + ["status", "<status>", "<extra-info>"], + ["amount", "requested-payment-amount", "<bolt11>"], + ["e", "<job-request-id>", "<relay-hint>"], + ["p", "<customer's-pubkey>"], + ], + // other fields... +} +``` + +* `content`: Either empty or a job-result (e.g. for partial-result samples) +* `amount` tag: as defined in the [Job Result](#job-result-kind6000-6999) section. +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Job Feedback Status](#job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. + +* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key. + +### Job feedback status + +| status | description | +| -------- | ------------- | +| `payment-required` | Service Provider requires payment before continuing. | +| `processing` | Service Provider is processing the job. | +| `error` | Service Provider was unable to process the job. | +| `success` | Service Provider successfully processed the job. | +| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | + +Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result-kind6000-6999) section. This is useful for service providers to provide a sample of the results that have been processed so far. + + +## Protocol Flow + +* Customer publishes a job request (e.g. `kind:5000` speech-to-text). +* Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event. +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user. + +Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers MUST use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. + +Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. + +### Notes about the protocol flow +The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. + +Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering results, some might choose to serve partial results for the job (e.g. a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. + +It's not up to this NIP to define how individual vending machines should choose to run their business. + +## Cancellation +A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event. + +## Appendix 1: Job chaining +A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. + +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. + +This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). + +## Appendix 2: Service provider discoverability +Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: + +```jsonc +{ + "kind": 31990, + "pubkey": "<pubkey>", + "content": "{ + \"name\": \"Translating DVM\", + \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" + }", + "tags": [ + ["k", "5005"], // e.g. translation + ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" + ], + // other fields... +} +``` + +Customers can use NIP-89 to see what service providers their follows use. diff --git a/docs/nips/92.md b/docs/nips/92.md new file mode 100644 index 00000000..d6e9932c --- /dev/null +++ b/docs/nips/92.md @@ -0,0 +1,45 @@ +NIP-92 +====== + +Media Attachments +----------------- + +Media attachments (images, videos, and other files) may be added to events by including a URL in the event content, along with a matching `imeta` tag. + +`imeta` ("inline metadata") tags MAY add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients MAY replace imeta URLs with rich previews. + +The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. +Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` MAY include +any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per URL. + +## Example + +```json +{ + "content": "More image metadata tests don’t mind me https://nostr.build/i/my-image.jpg", + "kind": 1, + "tags": [ + [ + "imeta", + "url https://nostr.build/i/my-image.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt A scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt1.jpg", + "fallback https://void.cat/alt1.jpg" + ] + ] +} +``` + +## Recommended client behavior + +When uploading files during a new post, clients MAY include this metadata +after the file is uploaded and included in the post. + +When pasting URLs during post composition, the client MAY download the file +and add this metadata before the post is sent. + +The client MAY ignore `imeta` tags that do not match the URL in the event content. diff --git a/docs/nips/94.md b/docs/nips/94.md new file mode 100644 index 00000000..4cd7c826 --- /dev/null +++ b/docs/nips/94.md @@ -0,0 +1,58 @@ +NIP-94 +====== + +File Metadata +------------- + +`draft` `optional` + +The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with `kind:1` notes or by longform clients that deal with `kind:30023` articles. + +## Event format + +This NIP specifies the use of the `1063` event kind, having in `content` a description of the file content, and a list of tags described below: + +* `url` the url to download the file +* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. +* `x` containing the SHA-256 hexencoded string of the file. +* `ox` containing the SHA-256 hexencoded string of the original file, before any transformations done by the upload server +* `size` (optional) size of file in bytes +* `dim` (optional) size of file in pixels in the form `<width>x<height>` +* `magnet` (optional) URI to magnet file +* `i` (optional) torrent infohash +* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client +* `thumb` (optional) url of thumbnail with same aspect ratio +* `image` (optional) url of preview image with same dimensions +* `summary` (optional) text excerpt +* `alt` (optional) description for accessibility +* `fallback` (optional) zero or more fallback file sources in case `url` fails +* `service` (optional) service type which is serving the file (eg. [NIP-96](96.md)) + +```jsonc +{ + "kind": 1063, + "tags": [ + ["url",<string with URI of file>], + ["m", <MIME type>], + ["x", <Hash SHA-256>], + ["ox", <Hash SHA-256>], + ["size", <size of file in bytes>], + ["dim", <size of file in pixels>], + ["magnet", <magnet URI> ], + ["i", <torrent infohash>], + ["blurhash", <value>], + ["thumb", <string with thumbnail URI>, <Hash SHA-256>], + ["image", <string with preview URI>, <Hash SHA-256>], + ["summary", <excerpt>], + ["alt", <description>] + ], + "content": "<caption>", + // other fields... +} +``` + +## Suggested use cases + +* A relay for indexing shared files. For example, to promote torrents. +* A pinterest-like client where people can share their portfolio and inspire others. +* A simple way to distribute configurations and software updates. diff --git a/docs/nips/96.md b/docs/nips/96.md new file mode 100644 index 00000000..28bc8a89 --- /dev/null +++ b/docs/nips/96.md @@ -0,0 +1,338 @@ +> __Warning__ `unrecommended`: deprecated in favor of [NIP-B7](B7.md) + +NIP-96 +====== + +HTTP File Storage Integration +----------------------------- + +`draft` `optional` + +## Introduction + +This NIP defines a REST API for HTTP file storage servers intended to be used in conjunction with the nostr network. +The API will enable nostr users to upload files and later reference them by url on nostr notes. + +The spec DOES NOT use regular nostr events through websockets for +storing, requesting nor retrieving data because, for simplicity, the server +will not have to learn anything about nostr relays. + +## Server Adaptation + +File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`: + +```jsonc +{ + // Required + // File upload and deletion are served from this url + // Also downloads if "download_url" field is absent or empty string + "api_url": "https://your-file-server.example/custom-api-path", + // Optional + // If absent, downloads are served from the api_url + "download_url": "https://a-cdn.example/a-path", + // Optional + // Note: This field is not meant to be set by HTTP Servers. + // Use this if you are a nostr relay using your /.well-known/nostr/nip96.json + // just to redirect to someone else's http file storage server's /.well-known/nostr/nip96.json + // In this case, "api_url" field must be an empty string + "delegated_to_url": "https://your-file-server.example", + // Optional + "supported_nips": [60], + // Optional + "tos_url": "https://your-file-server.example/terms-of-service", + // Optional + "content_types": ["image/jpeg", "video/webm", "audio/*"], + // Optional + "plans": { + // "free" is the only standardized plan key and + // clients may use its presence to learn if server offers free storage + "free": { + "name": "Free Tier", + // Default is true + // All plans MUST support NIP-98 uploads + // but some plans may also allow uploads without it + "is_nip98_required": true, + "url": "https://...", // plan's landing page if there is one + "max_byte_size": 10485760, + // Range in days / 0 for no expiration + // [7, 0] means it may vary from 7 days to unlimited persistence, + // [0, 0] means it has no expiration + // early expiration may be due to low traffic or any other factor + "file_expiration": [14, 90], + "media_transformations": { + "image": [ + "resizing" + ] + } + } + } +} +``` + +### Relay Hints + +Note: This section is not meant to be used by HTTP Servers. + +A nostr relay MAY redirect to someone else's HTTP file storage server by +adding a `/.well-known/nostr/nip96.json` with "delegated_to_url" field +pointing to the url where the server hosts its own +`/.well-known/nostr/nip96.json`. In this case, the "api_url" field must +be an empty string and all other fields must be absent. + +If the nostr relay is also an HTTP file storage server, +it must use the "api_url" field instead. + +### List of Supporting File Storage Servers + +See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. + +## Auth + +When indicated, `clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). + +## Upload + +`POST $api_url` as `multipart/form-data`. + +**AUTH required** + +List of form fields: + +- `file`: **REQUIRED** the file to upload +- `caption`: **RECOMMENDED** loose description; +- `expiration`: UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this. +- `size`: File byte size. This is just a value the server can use to reject early if the file size exceeds the server limits. +- `alt`: **RECOMMENDED** strict description text for visibility-impaired users. +- `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment. +- `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. +- `no_transform`: "true" asks server not to transform the file and serve the uploaded file as is, may be rejected. + +Others custom form data fields may be used depending on specific `server` support. +The `server` isn't required to store any metadata sent by `clients`. + +The `filename` embedded in the file may not be honored by the `server`, which could internally store just the SHA-256 hash value as the file name, ignoring extra metadata. +The hash is enough to uniquely identify a file, that's why it will be used on the `download` and `delete` routes. + +The `server` MUST link the user's `pubkey` string as the owner of the file so to later allow them to delete the file. + +`no_transform` can be used to replicate a file to multiple servers for redundancy, clients can use the [server list](#selecting-a-server) to find alternative servers which might contain the same file. When uploading a file and requesting `no_transform` clients should check that the hash matches in the response in order to detect if the file was modified. + +### Response codes + +- `200 OK`: File upload exists, but is successful (Existing hash) +- `201 Created`: File upload successful (New hash) +- `202 Accepted`: File upload is awaiting processing, see [Delayed Processing](#delayed-processing) section +- `413 Payload Too Large`: File size exceeds limit +- `400 Bad Request`: Form data is invalid or not supported. +- `403 Forbidden`: User is not allowed to upload or the uploaded file hash didnt match the hash included in the `Authorization` header `payload` tag. +- `402 Payment Required`: Payment is required by the server, **this flow is undefined**. + +The upload response is a json object as follows: + +```jsonc +{ + // "success" if successful or "error" if not + "status": "success", + // Free text success, failure or info message + "message": "Upload successful.", + // Optional. See "Delayed Processing" section + "processing_url": "...", + // This uses the NIP-94 event format but DO NOT need + // to fill some fields like "id", "pubkey", "created_at" and "sig" + // + // This holds the download url ("url"), + // the ORIGINAL file hash before server transformations ("ox") + // and, optionally, all file metadata the server wants to make available + // + // nip94_event field is absent if unsuccessful upload + "nip94_event": { + // Required tags: "url" and "ox" + "tags": [ + // Can be same from /.well-known/nostr/nip96.json's "download_url" field + // (or "api_url" field if "download_url" is absent or empty) with appended + // original file hash. + // + // Note we appended .png file extension to the `ox` value + // (it is optional but extremely recommended to add the extension as it will help nostr clients + // with detecting the file type by using regular expression) + // + // Could also be any url to download the file + // (using or not using the /.well-known/nostr/nip96.json's "download_url" prefix), + // for load balancing purposes for example. + ["url", "https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png"], + // SHA-256 hash of the ORIGINAL file, before transformations. + // The server MUST store it even though it represents the ORIGINAL file because + // users may try to download/delete the transformed file using this value + ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + // Optional. SHA-256 hash of the saved file after any server transformations. + // The server can but does not need to store this value. + ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"], + // Optional. Recommended for helping clients to easily know file type before downloading it. + ["m", "image/png"], + // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it. + ["dim", "800x600"] + // ... other optional NIP-94 tags + ], + "content": "" + }, + // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags) +} +``` + +Note that if the server didn't apply any transformation to the received file, both `nip94_event.tags.*.ox` and `nip94_event.tags.*.x` fields will have the same value. The server MUST link the saved file to the SHA-256 hash of the **original** file before any server transformations (the `nip94_event.tags.*.ox` tag value). The **original** file's SHA-256 hash will be used to identify the saved file when downloading or deleting it. + +`clients` may upload the same file to one or many `servers`. +After successful upload, the `client` may optionally generate and send to any set of nostr `relays` a [NIP-94](94.md) event by including the missing fields. + +Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url. + +`clients` may also use the tags from the `nip94_event` to construct an `imeta` tag + +### Delayed Processing + +Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing. + +In that case, the server MUST serve the original file while the processing isn't done, then swap the original file for the processed one when the processing is over. The upload response is the same as usual but some optional metadata like `nip94_event.tags.*.x` and `nip94_event.tags.*.size` won't be available. + +The expected resulting metadata that is known in advance should be returned on the response. +For example, if the file processing would change a file from "jpg" to "webp", +use ".webp" extension on the `nip94_event.tags.*.url` field value and set "image/webp" to the `nip94_event.tags.*.m` field. +If some metadata are unknown before processing ends, omit them from the response. + +The upload response MAY include a `processing_url` field informing a temporary url that may be used by clients to check if +the file processing is done. + +If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON: + +```jsonc +{ + // It should be "processing". If "error" it would mean the processing failed. + "status": "processing", + "message": "Processing. Please check again later for updated status.", + "percentage": 15 // Processing percentage. An integer between 0 and 100. +} +``` + +When the processing is over, the server replies at the `processing_url` url with **201 Created** status and a regular successful JSON response already mentioned before (now **without** a `processing_url` field), possibly including optional metadata at `nip94_event.tags.*` fields +that weren't available before processing. + +### File compression + +File compression and other transformations like metadata stripping can be applied by the server. +However, for all file actions, such as download and deletion, the **original** file SHA-256 hash is what identifies the file in the url string. + +## Download + +`GET $api_url/<sha256-hash>(.ext)` + +The primary file download url informed at the upload's response field `nip94_event.tags.*.url` +can be that or not (it can be any non-standard url the server wants). +If not, the server still MUST also respond to downloads at the standard url +mentioned on the previous paragraph, to make it possible for a client +to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash. + +Note that the "\<sha256-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. + +Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path. +When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension). +The file extension may be absent because the hash is the only needed string to uniquely identify a file. + +Example: `$api_url/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` + +### Media Transformations + +`servers` may respond to some media transformation query parameters and ignore those they don't support by serving +the original media file without transformations. + +#### Image Transformations + +##### Resizing + +Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio. +`clients` may use the `w` query parameter to request an image version with the desired pixel width. +`servers` can then serve the variant with the closest width to the parameter value +or an image variant generated on the fly. + +Example: `$api_url/<sha256-hash>.png?w=32` + +## Deletion + +`DELETE $api_url/<sha256-hash>(.ext)` + +**AUTH required** + +Note that the `/<sha256-hash>` part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. + +The extension is optional as the file hash is the only needed file identification. + +The `server` should reject deletes from users other than the original uploader with the appropriate http response code (403 Forbidden). + +It should be noted that more than one user may have uploaded the same file (with the same hash). In this case, a delete must not really delete the file but just remove the user's `pubkey` from the file owners list (considering the server keeps just one copy of the same file, because multiple uploads of the same file results +in the same file hash). + +The successful response is a 200 OK one with just basic JSON fields: + +```json +{ + "status": "success", + "message": "File deleted." +} +``` + +## Listing files + +`GET $api_url?page=x&count=y` + +**AUTH required** + +Returns a list of files linked to the authenticated users pubkey. + +Example Response: + +```jsonc +{ + "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) + "total": 1, // total number of files + "page": 0, // the current page number + "files": [ + { + "tags": [ + ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + ["x", "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], + ["size", "123456"], + ["alt", "a meme that makes you laugh"], + ["expiration", "1715691139"], + // ...other metadata + ], + "content": "haha funny meme", // caption + "created_at": 1715691130 // upload timestamp + } + ] +} +``` + +`files` contains an array of NIP-94 events + +### Query args + +- `page` page number (`offset=page*count`) +- `count` number of items per page + +## Selecting a Server + +Note: HTTP File Storage Server developers may skip this section. This is meant for client developers. + +A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants +to upload files to. Servers are listed as `server` tags: + +```jsonc +{ + "kind": 10096, + "content": "", + "tags": [ + ["server", "https://file.server.one"], + ["server", "https://file.server.two"] + ], + // other fields... +} +``` diff --git a/docs/nips/98.md b/docs/nips/98.md new file mode 100644 index 00000000..be425b28 --- /dev/null +++ b/docs/nips/98.md @@ -0,0 +1,63 @@ +NIP-98 +====== + +HTTP Auth +--------- + +`draft` `optional` + +This NIP defines an ephemeral event used to authorize requests to HTTP servers using nostr events. + +This is useful for HTTP services which are built for Nostr and deal with Nostr user accounts. + +## Nostr event + +A `kind 27235` (In reference to [RFC 7235](https://www.rfc-editor.org/rfc/rfc7235)) event is used. + +The `content` SHOULD be empty. + +The following tags MUST be included. + +* `u` - absolute URL +* `method` - HTTP Request Method + +Example event: +```json +{ + "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734", + "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed", + "content": "", + "kind": 27235, + "created_at": 1682327852, + "tags": [ + ["u", "https://api.snort.social/api/v1/n5sp/list"], + ["method", "GET"] + ], + "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184" +} +``` + +Servers MUST perform the following checks in order to validate the event: +1. The `kind` MUST be `27235`. +2. The `created_at` timestamp MUST be within a reasonable time window (suggestion 60 seconds). +3. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters). +4. The `method` tag MUST be the same HTTP method used for the requested resource. + +When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD include a SHA256 hash of the request body in a `payload` tag as hex (`["payload", "<sha256-hex>"]`), servers MAY check this to validate that the requested payload is authorized. + +If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code. + +Servers MAY perform additional implementation-specific validation checks. + +## Request Flow + +Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` + +Example HTTP Authorization header: +``` +Authorization: Nostr +eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1IiwiaHR0cHM6Ly9hcGkuc25vcnQuc29jaWFsL2FwaS92MS9uNXNwL2xpc3QiXSxbIm1ldGhvZCIsIkdFVCJdXSwic2lnIjoiNWVkOWQ4ZWM5NThiYzg1NGY5OTdiZGMyNGFjMzM3ZDAwNWFmMzcyMzI0NzQ3ZWZlNGEwMGUyNGY0YzMwNDM3ZmY0ZGQ4MzA4Njg0YmVkNDY3ZDlkNmJlM2U1YTUxN2JiNDNiMTczMmNjN2QzMzk0OWEzYWFmODY3MDVjMjIxODQifQ +``` + +## Reference Implementations +- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) diff --git a/docs/nips/99.md b/docs/nips/99.md new file mode 100644 index 00000000..2b6a97af --- /dev/null +++ b/docs/nips/99.md @@ -0,0 +1,86 @@ +NIP-99 +====== + +Classified Listings +------------------- + +`draft` `optional` + +This NIP defines `kind:30402`: an addressable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful. + +The specification supports a broad range of use cases physical goods, services, work opportunities, rentals, free giveaways, personals, etc. To promote interoperability between clients implementing NIP-99 for e-commerce, you can find the extension proposal [here](https://github.com/GammaMarkets/market-spec/blob/main/spec.md) which standardizes the e-commerce use case while maintaining the specification's lightweight and flexible nature. While [NIP-15](15.md) provides a strictly structured marketplace specification, NIP-99 has emerged as a simpler and more flexible alternative. + +The structure of these events is very similar to [NIP-23](23.md) long-form content events. + +### Draft / Inactive Listings + +`kind:30403` has the same structure as `kind:30402` and is used to save draft or inactive classified listings. + +### Content + +The `.content` field should be a description of what is being offered and by whom. These events should be a string in Markdown syntax. + +### Author + +The `.pubkey` field of these events are treated as the party creating the listing. + +### Metadata + +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used. +- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily. + +The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. + +- `"title"`, a title for the listing +- `"summary"`, for short tagline or summary for the listing +- `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. +- `"location"`, for the location. +- `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "<number>", "<currency>", "<frequency>" ]`. + - `"price"` is the name of the tag + - `"<number>"` is the amount in numeric format (but included in the tag as a string) + - `"<currency>"` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). + - `"<frequency>"` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) +- `"status"` (optional), the status of the listing. SHOULD be either "active" or "sold". + +#### `price` examples + +- $50 one-time payment `["price", "50", "USD"]` +- €15 per month `["price", "15", "EUR", "month"]` +- £50,000 per year `["price", "50000", "GBP", "year"]` + +Other common tags that might be useful. + +- `"g"`, a geohash for more precise location + +## Example Event + +```jsonc +{ + "kind": 30402, + "created_at": 1675642635, + // Markdown content + "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.", + "tags": [ + ["d", "lorem-ipsum"], + ["title", "Lorem Ipsum"], + ["published_at", "1296962229"], + ["t", "electronics"], + ["image", "https://url.to.img", "256x256"], + ["summary", "More lorem ipsum that is a little more than the title"], + ["location", "NYC"], + ["price", "100", "USD"], + [ + "e", + "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", + "wss://relay.example.com" + ], + [ + "a", + "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", + "wss://relay.nostr.org" + ] + ], + "pubkey": "...", + "id": "..." +} +``` diff --git a/docs/nips/A0.md b/docs/nips/A0.md new file mode 100644 index 00000000..884bf2aa --- /dev/null +++ b/docs/nips/A0.md @@ -0,0 +1,60 @@ +NIP-A0 +====== + +Voice Messages +----------- + +**Status:** Draft + +This NIP defines new events `kind: 1222` for root messages and `kind: 1244` for reply messages to be used for short voice messages, typically up to 60 seconds in length. + +## Specification + +### Event Kind `1222` and Kind `1244` + +The `kind: 1222` event is defined as follows: + +- `content`: MUST be a URL pointing directly to an audio file. + - The audio file SHOULD be in `audio/mp4` (.m4a) format using AAC or Opus encoding. Clients MAY support other common audio formats like `audio/ogg`, `audio/webm`, or `audio/mpeg` (mp3), but `audio/mp4` is recommended for broad compatibility and efficiency. + - The audio duration SHOULD be no longer than 60 seconds. Clients publishing `kind: 1222` events SHOULD enforce this limit or provide a clear warning to the user if exceeded. +- `tags`: + - Tags MAY be included as per other NIPs (e.g., `t` for hashtags, `g` for geohash, etc.). + + The `kind: 1244` event is defined as follows: + +- To be used for replies, `kind: 1244` events MUST follow the structure of `NIP-22`. +- `content`: MUST be a URL pointing directly to an audio file. + - The audio file SHOULD be in `audio/mp4` (.m4a) format using AAC or Opus encoding. Clients MAY support other common audio formats like `audio/ogg`, `audio/webm`, or `audio/mpeg` (mp3), but `audio/mp4` is recommended for broad compatibility and efficiency. + - The audio duration SHOULD be no longer than 60 seconds. Clients publishing `kind: 1222` events SHOULD enforce this limit or provide a clear warning to the user if exceeded. +- `tags`: + - Tags MAY be included as per other NIPs (e.g., `t` for hashtags, `g` for geohash, etc.). + + +## Visual representation with `imeta` (NIP-92) tag (optional) + +The following imeta (NIP-92) tags MAY be included so clients can render a visual preview without having to download the audio file first: + +- `waveform`: amplitude values over time, space separated full integers, less than 100 values should be enough to render a nice visual +- `duration`: audio length in seconds + +## Examples + +### Root Voice Message Example + +```json +{ + "content": "https://blossom.primal.net/5fe7df0e46ee6b14b5a8b8b92939e84e3ca5e3950eb630299742325d5ed9891b.mp4", + "created_at": 1752501052, + "id": "...", + "kind": 1222, + "pubkey": "...", + "sig": "...", + "tags": [ + [ + "imeta", + "url https://blossom.primal.net/5fe7df0e46ee6b14b5a8b8b92939e84e3ca5e3950eb630299742325d5ed9891b.mp4", + "waveform 0 7 35 8 100 100 49 8 4 16 8 10 7 2 20 10 100 100 100 100 100 100 15 100 100 100 25 60 5 4 3 1 0 100 100 15 100 29 88 0 33 11 39 100 100 19 4 100 42 35 5 0 1 5 0 0 11 38 100 94 17 11 44 58 5 100 100 100 55 14 72 100 100 57 6 1 14 2 16 100 100 40 16 100 100 6 32 14 13 41 36 16 14 6 3 0 1 2 1 6 0", + "duration 8" + ] + ] +} \ No newline at end of file diff --git a/docs/nips/B0.md b/docs/nips/B0.md new file mode 100644 index 00000000..22ed9105 --- /dev/null +++ b/docs/nips/B0.md @@ -0,0 +1,53 @@ +NIP-B0 +====== + +Web Bookmarking +--------------- + +`draft` `optional` + +This NIP defines `kind:39701` for a URI as editable web bookmark which uses the HTTP scheme. + +### Format + +The format uses `kind:39701`. + +The `.content` should be a detailed description of the web bookmark. It can be an empty string. + +The `d` tag is just their URL without the scheme, which is always and everywhere assumed to be `https://` or `http://`. + +In this way web bookmarks events can be queried by the `d` tag by clients. + +### Metadata + +Metadata fields can be added as tags to the event as necessary. + +* `"t"`, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) +* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the bookmark was published +* `"title"`, title about bookmark and can be used as a attribute for the HTML link element + +## Example event + +```jsonc +{ + "kind": 39701, + "id": "d7a92714f81d0f712e715556aee69ea6da6bfb287e6baf794a095d301d603ec7", + "pubkey": "2729620da105979b22acfdfe9585274a78c282869b493abfa4120d3af2061298", + "created_at": 1738869705, + "tags": [ + // Required tags + ["d", "alice.blog/post"], + // Optional tags + ["published_at", "1738863000"], + ["title", "Blog insights by Alice"], + ["t", "post"], + ["t", "insight"] + ], + "content": "A marvelous insight by Alice about the nature of blogs and posts.", + "sig": "36d34e6448fe0223e9999361c39c492a208bc423d2fcdfc2a3404e04df7c22dc65bbbd62dbe8a4373c62e4d29aac285b5aa4bb9b4b8053bd6207a8b45fbd0c98" +} +``` + +### Replies & Comments + +Replies to `kind 39701` MUST use `kind 1111` events as comments with [NIP-22](22.md). diff --git a/docs/nips/B7.md b/docs/nips/B7.md new file mode 100644 index 00000000..0e0fd347 --- /dev/null +++ b/docs/nips/B7.md @@ -0,0 +1,41 @@ +NIP-B7 +====== + +Blossom media +------------- + +`draft` `optional` + +This NIP specifies how Nostr clients can use [Blossom][] for handling media. + +Blossom is a set of standards (called BUDs) for dealing with servers that store files addressable by their SHA-256 sums. Nostr clients may make use of all the BUDs for allowing users to upload files, manage their own files and so on, but most importantly Nostr clients SHOULD make use of [BUD-03][] to fetch `kind:10063` lists of servers for each user: + +```json +{ + "id": "e4bee088334cb5d38cff1616e964369c37b6081be997962ab289d6c671975d71", + "pubkey": "781208004e09102d7da3b7345e64fd193cd1bc3fce8fdae6008d77f9cabcd036", + "content": "", + "kind": 10063, + "created_at": 1708774162, + "tags": [ + ["server", "https://blossom.self.hosted"], + ["server", "https://cdn.blossom.cloud"] + ], + "sig": "cc5efa74f59e80622c77cacf4dd62076bcb7581b45e9acff471e7963a1f4d8b3406adab5ee1ac9673487480e57d20e523428e60ffcc7e7a904ac882cfccfc653" +} +``` + +Whenever a Nostr client finds a URL in an event published by a given user and that URL ends a 64-character hex string (with or without an ending file extension) and that URL is not available anymore, that means that string is likely a representation of a sha256 and that the user may have a `kind:10063` list of Blossom servers published. + +Given that, the client SHOULD look into the `kind:10063` list for other Blossom servers and lookup for the same 64-character hex string in them, by just using the hex string as a path (optionally with the file extension at the end), producing a URL like `https://blossom.self.hosted/<hex-string>.png`. + +When downloading such files Nostr clients SHOULD verify that the sha256-hash of its contents matches the 64-character hex string. + +More information can be found at [BUD-03][]. + +### More complex interactions + +Clients may use other facilities exposed by Blossom servers (for example, for checking if a file exists in a Blossom server, instead of actually downloading it) which are better documented in the [BUDs][Blossom]. + +[Blossom]: https://github.com/hzrd149/blossom +[BUD-03]: https://github.com/hzrd149/blossom/blob/master/buds/03.md diff --git a/docs/nips/C0.md b/docs/nips/C0.md new file mode 100644 index 00000000..c88e1455 --- /dev/null +++ b/docs/nips/C0.md @@ -0,0 +1,69 @@ +NIP-C0 +====== + +Code Snippets +------------- + +`draft` `optional` + +## Abstract + +This NIP defines a new event kind for sharing and storing code snippets. Unlike regular text notes (`kind:1`), code snippets have specialized metadata like language, extension, and other code-specific attributes that enhance discoverability, syntax highlighting, and improved user experience. + +## Event Kind + +This NIP defines `kind:1337` as a code snippet event. + +The `.content` field contains the actual code snippet text. + +## Optional Tags + +- `l` - Programming language name (lowercase). Examples: "javascript", "python", "rust" +- `name` - Name of the code snippet, commonly a filename. Examples: "hello-world.js", "quick-sort.py" +- `extension` - File extension (without the dot). Examples: "js", "py", "rs" +- `description` - Brief description of what the code does +- `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11") +- `license` - License under which the code is shared (e.g., "MIT", "GPL-3.0", "Apache-2.0") +- `dep` - Dependency required for the code to run (can be repeated) +- `repo` - Reference to a repository where this code originates + +## Format + +```json +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": <Unix timestamp in seconds>, + "kind": 1337, + "content": "function helloWorld() {\n console.log('Hello, Nostr!');\n}\n\nhelloWorld();", + "tags": [ + ["l", "javascript"], + ["extension", "js"], + ["name", "hello-world.js"], + ["description", "A basic JavaScript function that prints 'Hello, Nostr!' to the console"], + ["runtime", "node v18.15.0"], + ["license", "MIT"], + ["repo", "https://github.com/nostr-protocol/nostr"] + ], + "sig": "<64-bytes signature of the id>" +} +``` + +## Client Behavior + +Clients that support this NIP SHOULD: + +1. Display code snippets with proper syntax highlighting based on the language. +2. Allow copying the full code snippet with a single action. +3. Render the code with appropriate formatting, preserving whitespace and indentation. +4. Display the language and extension prominently. +5. Provide "run" functionality for supported languages when possible. +6. Display the description (if available) as part of the snippet presentation. + +Clients MAY provide additional functionality such as: + +1. Code editing capabilities +2. Forking/modifying snippets +3. Creating executable environments based on the runtime/dependencies +4. Downloading the snippet as a file using the provided extension +5. Sharing the snippet with attribution diff --git a/docs/nips/C7.md b/docs/nips/C7.md new file mode 100644 index 00000000..0d94f18b --- /dev/null +++ b/docs/nips/C7.md @@ -0,0 +1,29 @@ +NIP-C7 +====== + +Chats +----- + +`draft` `optional` + +A chat message is a `kind 9` event. + +```json +{ + "kind": 9, + "content": "GM", + "tags": [] +} +``` + +A reply to a `kind 9` is an additional `kind 9` which quotes the parent using a `q` tag. + +```json +{ + "kind": 9, + "content": "nostr:nevent1...\nyes", + "tags": [ + ["q", <event-id>, <relay-url>, <pubkey>] + ] +} +``` diff --git a/docs/nips/EE.md b/docs/nips/EE.md new file mode 100644 index 00000000..090fa29f --- /dev/null +++ b/docs/nips/EE.md @@ -0,0 +1,288 @@ +# NIP-EE + +## E2EE Messaging using the Messaging Layer Security (MLS) Protocol + +`draft` `optional` + +This NIP standardizes how to use the [MLS Protocol](https://www.rfc-editor.org/rfc/rfc9420.html) with Nostr for efficient and E2EE (end-to-end encrypted) direct and group messaging. + +## Context + +Originally, one-to-one direct messages (DMs) in Nostr happened via the scheme defined in [NIP-04](04.md). This NIP is not recommended because, while it encrypts the content of the message (provides decent confidentiality), it leaks significant amounts of metadata about the parties involved in the conversation (completely lacks privacy). + +With the addition of [NIP-44](44.md), we have an updated encryption scheme that improves confidentiality guarantees but stops short of defining a new scheme for doing direct messages using this encryption scheme. Hence, makes little to no difference to privacy. + +Most recently, [NIP-17](17.md) combines [NIP-44](44.md) encryption with [NIP-59](59.md) gift-wrapping to hide the encrypted direct message inside another set of events to ensure that it's impossible to see who is talking to who and when messages passed between the users. This largely solves the metadata leakage problem; while it's still possible to see that a user is receiving gift-wrapped events, you can't tell from whom and what kind of events are within the gift-wrap outer event. This gives some degree of deniability/repudiation but doesn't solve forward secrecy or post compromise security. That is to say, if a user's private key (or the calculated conversation key shared between two users used to encrypt messages) is compromised, the attacker will have full access to all past and future DMs sent between those users. + +In addition, neither [NIP-04](04.md) or [NIP-17](17.md) attempt to solve the problem of group messages. + +### Why is this important? + +Without proper E2EE, Nostr cannot be used as the protocol for secure messaging clients. While clients like Signal do a fantastic job with E2EE, they still rely on centralized servers and as a result can be shut down by a powerful (i.e. state-level) actor. The goal of Nostr is not only to protect against centralized entities censoring you and your communications, but also protect against the ability of a state-level actor to stop these sorts of services from existing in the first place. By replacing centralized servers with decentralized relays, we make it nearly impossible for a centralized actor to completely stop communications between individual users. + +### Goals of this NIP + +1. Private _and_ Confidential DMs and Group messages + 1. **Private** means that an observer cannot tell that Alice and Bob are talking to one another, or that Alice is part of a specific group. This necessarily requires protecting metadata. + 2. **Confidential** means that the contents of conversations can only be viewed by the intended recipients. +2. Forward secrecy and Post-compromise security + 1. **Forward secrecy** means that encrypted content in the past remains encrypted even if a key material is leaked. + 2. **Post compromise security** means that leaking key material doesn't allow an attacker to continue to read messages indefinitely into the future. +3. Scales efficiently for large groups +4. Allows for the use of multiple device/clients in a single conversation/group. + +### Why MLS? + +This scheme adapts the Message Layer Security (MLS) protocol for use with Nostr. You can think of MLS as an evolution of the Signal Protocol. However, it significantly improves the scalability of encryption operations for large group messaging significantly (linear -> log), is built to accommodate federated environments, and also allows for graceful updating of ciphersuites and versions over time. In addition, it's very flexible and agnostic about the message content that is sent. + +It's beyond the scope of this NIP to explain the MLS protocol but you can read more about it in it's [Architectural Overview](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-13.html) or the [RFC](https://www.rfc-editor.org/rfc/rfc9420). MLS is on track to become an internet standard under the IETF so the protocol itself is extremely well vetted and researched. This also means there is the potential for cross network messaging interoperability in the future as MLS gains more adoption. + +## Core MLS Concepts + +From the [MLS Architectural Overview](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-13.html): + +> MLS provides a way for clients to form groups within which they can communicate securely. For example, a set of users might use clients on their phones or laptops to join a group and communicate with each other. A group may be as small as two clients (e.g., for simple person to person messaging) or as large as hundreds of thousands. A client that is part of a group is a member of that group. As groups change membership and group or member properties, they advance from one epoch to another and the cryptographic state of the group evolves. +> +> The group is represented as a tree, which represents the members as the leaves of a tree. It is used to efficiently encrypt to subsets of the members. Each member has a state called a LeafNode object holding the client's identity, credentials, and capabilities. + +The MLS protocol's job is to manage and evolve the cryptographic state of a group. This includes managing the membership of a group, the cryptographic state of a group (ratchet tree, keys, and encryption/decryption/authentication of messages), and managing the evolution of the group over time. + +### Groups + +Groups are created by their first member, who then invites one or more other members. Groups evolve over time in blocks called `Epochs`. New epochs are proposed via one ore more `Proposal` messages and then committed to via a `Commit` message. + +### Clients + +The device/client pair (e.g. Primal on iOS or Coracle on web) with which a user joins the group is represented as a `LeafNode` in the tree. The terms `Client` and `Member` are interchangeable in this regard. It is not possible to share group state across multiple `Clients`. If a user joins a group from 2 separate devices, their state is separate and they will be tracked as 2 separate members of the group. + +### Messages + +There are several different types of messages sent within a group. Some of these are control messages that are used to update the group state over time. These include `Welcome`, `Proposal`, and `Commit` messages. Others are the actual messages that are sent between members in a group. These include `Application` messages. + +Messages in MLS are "framed". Meaning that they are wrapped in a data structure that includes information about the sender, the epoch, the message index within the epoch and the message content. This framing makes it possible to authenticate and decrypt messages correctly, even if they arrive out of order. + +MLS is agnostic to the "content" of the messages that are sent. This is a key feature of MLS that allows for the use of MLS for a wide variety of applications. + +MLS is also agnostic to the transport protocol that is used to send messages. Obviously for us, we'll be using websockets, Nostr events and relays. + +## The focus of this NIP + +This NIP focuses on how to use Nostr to perform the Authentication Service and Delivery Service functions required by the MLS protocol. Most clients will choose to use an MLS implementation to handle keys, ratcheting, group state management, and other aspects of the MLS protocol itself. [OpenMLS](https://github.com/openmls/openmls) is the most actively developed library that implements MLS. + +This NIP specifies the following: + +1. A standardized way that Nostr clients should [create MLS groups](#creating-groups). +2. The required format of the MLS [`Credential`](#mls-credentials) that Nostr clients should use to represent a Nostr user in a group. +3. The structure of [KeyPackage Events](#keypackage-event-and-signing-keys) published to relays that allow Nostr users to be added to a group asynchronously. +4. The structure of [Group Events](#group-events) published to relays that represent the evolution of a group's state and the contents of the messages sent in the group. + +## Security Considerations + +This is a concise overview of the security trade-offs and considerations of this NIP in various scenarios. The NIP strives to fully maintain MLS security guarantees. + +### Forward Secrecy and Post-compromise Security + +- As per the MLS spec, keys are deleted as soon as they are used to encrypt or decrypt a message. This is usually handled by the MLS implementation library itself but attention needs to be paid by clients to ensure they're not storing secrets (especially the [exporter secret](#group-events)) for longer than absolutely necessary. +- This NIP maintains MLS forward secrecy and post-compromise security guarantees. You can read more about those in the MLS Architectural Overview section on [Forward Secrecy and Post-compromise Security](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-15.html#name-forward-and-post-compromise). + +### Leakage of various keys + +- This NIP does not depend on a user's Nostr identity key for any aspect of the MLS messaging protocol. Compromise of a user's Nostr identity key does not give access to past or future messages in any MLS-based group. +- For a complete discussion of MLS key leakage, please see the Endpoint Compromise section of the [MLS Architectural Overview](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-15.html#name-endpoint-compromise). + +### Metadata + +- The only group specific metadata published to relays is the Nostr group ID value. This value is used to identify the group in the `h` tag of the Group Message Event (`kind: 445`). These events are published ephemerally and this Nostr group ID value can be updated over the lifetime of the group by group admins. This is a tradeoff to ensure that group participants and group size are obfuscated but still makes it possible to efficiently fan out group messages to all participants. The content field of this event is a value encrypted in two separate ways (using NIP-44 and MLS) with MLS group state/keys. Only group members with up-to-date group state can decrypt and read these messages. +- A user's key package events can be used one or more times to be added to groups. There is a tradeoff inherent here: Reusing key packages (initial signing keys) carries some degree of risk but this risk is mitigated as long as a user rotates their signing key immediately upon joining a group. This step also improves the forward secrecy of the entire group. + +### Device Compromise + +Clients implementing this NIP should take every precaution to ensure that data is stored in a secure way on the device and is protected against unwanted access in the case that a device is compromised (e.g. encryption at rest, biometric authentication, etc.). That said, full device compromise should be viewed as a catastrophic event and any group the compromised device was a part of should be considered compromised until they can remove that member and update their group's state. Some suggestions: + +- Clients should support and encourage self-destructing messages (ensuring that full transcript history isn't available on a device forever). +- Clients should regularly suggest to group admins that inactive users be removed. +- Clients should regularly suggest (or automatically) rotate a user's signing key in each of their groups. +- Clients should encrypt group state and keys on the device using a secret value that isn't part of the group state or the user's Nostr identity key. +- Clients should use secure enclave storage where possible. + +For a full discussion of the security considerations of MLS, please see the Security Considerations section of the [MLS RFC](https://www.rfc-editor.org/rfc/rfc9420.html#name-security-considerations). + +## Creating groups + +MLS Groups are created with a random 32-byte ID value that is effectively permanent. This ID should be treated as private to the group and MUST not be published to relays in any form. + +Clients must also ensure that the ciphersuite, capabilities, and extensions they use when creating the group are compatible with those advertised by the users they'd like to invite to the group. They can check this info via the user's published KeyPackage Events. + +When creating a new group, the following MLS extensions MUST be used. + +- [`required_capabilities`](https://docs.rs/openmls/latest/openmls/extensions/struct.RequiredCapabilitiesExtension.html) +- [`ratchet_tree`](https://docs.rs/openmls/latest/openmls/extensions/struct.RatchetTreeExtension.html) +- [`nostr_group_data`](https://github.com/rust-nostr/nostr/blob/master/mls/nostr-mls/src/extension.rs) + +And the following MLS extension is highly recommended (more [here](#keypackage-event-and-signing-keys)): +- [`last_resort`](https://docs.rs/openmls/latest/openmls/extensions/struct.LastResortExtension.html) + +Changes to an MLS group are affected by first creating one or more `Proposal` events and then committing to a set of proposals in a `Commit` event. These are MLS events, not Nostr events. However, for the group state to properly evolve the Commit events (which represent a specific set of proposals - like adding a new user to the group) must be published to relays for the other group members to see. See [Group Messages](#group-events) for more information. + +## MLS Credentials + +A `Credential` in MLS is an assertion of who the user is coupled with a signing key. When constructing `Credentials` for MLS, clients MUST use the `BasicCredential` type and set the `identity` value as the 32-byte hex-encoded public key of the user's Nostr identity key. Clients MUST not allow users to change the identity field and MUST validate that all `Proposal` messages do not attempt to change the identity field on any credential in the group. + +A `Credential` also has an associated signing key. The initial signing key for a user is included in the KeyPackage event. The signing key MUST be different from the user's Nostr identity key. This signing key SHOULD be rotated over time to provide improved post-compromise security. + +## Nostr Group Data Extension + +As mentioned above, the `nostr_group_data` extension is a required MLS extension used to associate Nostr-specific data with an MLS group in a cryptographically secure and proveable way. This extension MUST be included as a required capability when creating a new group. + +The extension stores the following data about the group: + +- `nostr_group_id`: A 32-byte ID for the group. This is a different value from the group ID used by MLS and CAN be changed over time. This value is the group ID value used in the `h` tags when sending group message events. +- `name`: The name of the group. +- `description`: A short description of the group. +- `admin_pubkeys`: An array of the hex-encoded public keys of the group admins. The MLS protocol itself does not have a concept of group admins. Clients MUST check the list of `admin_pubkeys` before making any change to the group data (anything in this extension), or before changing group membership (add/remove members), or updating any other aspect of the group itself (e.g. ciphersuite, etc.). Note, all members of the group can send `Proposal` and `Commits` messages for changes to their own credentials (e.g. updating their signing key). +- `relays`: An array of the Nostr relay URLs that the group uses to publish and receive messages. + +All of these values can be updated over time using MLS `Proposal` and `Commit` events (by group admins). + +## KeyPackage Event and Signing Keys + +Each user that wishes to be reachable via MLS-based messaging MUST first publish at least one KeyPackage event. The KeyPackage Event is used to authenticate users and create the necessary `Credential` to add members to groups in an asynchronous way. Users can publish multiple KeyPackage Events with different parameters (supporting different ciphersuites or MLS extensions, for example). KeyPackages include a signing key that is used for signing MLS messages within a group. This signing key MUST not be the same as the user's Nostr identity key. + +KeyPackage reuse SHOULD be minimized. However, in normal MLS use, KeyPackages are consumed when joining a group. In order to reduce race conditions between invites for multiple groups using the same Key Package, Nostr clients SHOULD use "Last resort" KeyPackages. This requires the inclusion of the `last_resort` extension on the KeyPackage's capabilities (same as with the Group). + +It's important that clients immediately rotate a user's signing key after joining a group via a last resort key package to improve post-compromise security. The signing key (the public key included in the KeyPackage Event) is used for signing within the group. Therefore, clients implementing this NIP MUST ensure that they retain access to the private key material of the signing key for each group they are a member of. + +In most cases, it's assumed that clients implementing this NIP will manage the creation and rotation of KeyPackage Events. + +### Example KeyPackage Event + +```json + { + "id": <id>, + "kind": 443, + "created_at": <unix timestamp in seconds>, + "pubkey": <main identity pubkey>, + "content": "", + "tags": [ + ["mls_protocol_version", "1.0"], + ["ciphersuite", <MLS CipherSuite ID value e.g. "0x0001">], + ["extensions", <An array of MLS Extension ID values e.g. "0x0001, 0x0002">], + ["client", <client name>, <handler event id>, <optional relay url>], + ["relays", <array of relay urls>], + ["-"] + ], + "sig": <signed with main identity key> +} +``` + +- The `content` hex encoded serialized `KeyPackageBundle` from MLS. +- The `mls_protocol_version` tag is required and MUST be the version number of the MLS protocol version being used. For now, this is `1.0`. +- The `ciphersuite` tag is the value of the MLS ciphersuite that this KeyPackage Event supports. [Read more about ciphersuites in MLS](https://www.rfc-editor.org/rfc/rfc9420.html#name-mls-cipher-suites). +- The `extensions` tag is an array of MLS extension IDs that this KeyPackage Event supports. [Read more about MLS extensions](https://www.rfc-editor.org/rfc/rfc9420.html#name-extensions). +- (optional) The `client` tag helps other clients manage the user experience when they receive group invites but don't have access to the signing key. +- The `relays` tag identifies each of the relays that the client will attempt to publish this KeyPackage event. This allows for deletion of KeyPackage Events at a later date. +- (optional) The `-` tag can be used to ensure that KeyPackage Events are only published by their authenticated author. Read more in [NIP-70](70.md) + +### Deleting KeyPackage Events + +Clients SHOULD delete the KeyPackage Event on all the listed relays any time they successfully process a group request event for a given KeyPackage Event. Clients MAY also create a new KeyPackage Event at the same time. + +If clients cannot process a Welcome message (e.g. because the signing key was generated on another client), clients MUST not delete the KeyPackage Event and SHOULD show a human-understandable error to the user. + +### Rotating Signing Keys + +Clients MUST regularly rotate the user's signing key in each group that they are a part of. The more often the signing key is rotated the stronger the post-compromise security. This rotation is done via `Proposal` and `Commit` events and broadcast to the group via a Group Event. [Read more about forward secrecy and post-compromise security inherent in MLS](https://www.rfc-editor.org/rfc/rfc9420.html#name-forward-secrecy-and-post-co). + +### KeyPackage Relays List Event + +A `kind: 10051` event indicates the relays that a user will publish their KeyPackage Events to. The event MUST include a list of relay tags with relay URIs. These relays SHOULD be readable by anyone the user wants to be able to contact them. + +```json +{ + "kind": 10051, + "tags": [ + ["relay", "wss://inbox.nostr.wine"], + ["relay", "wss://myrelay.nostr1.com"], + ], + "content": "", + //...other fields +} +``` + +### Welcome Event + +When a new user is added to a group via an MLS `Commit` message. The member who sends the `Commit` message to the group is responsible for sending the user being added to the group a Welcome Event. This Welcome Event is sent to the user as a [NIP-59](59.md) gift-wrapped event. The Welcome Event gives the new member the context they need to join the group and start sending messages. + +Clients creating the Welcome Event SHOULD wait until they have received acknowledgement from relays that their Group Event with the `Commit` has been received before publishing the Welcome Event. + +```json +{ + "id": <id>, + "kind": 444, + "created_at": <unix timestamp in seconds>, + "pubkey": <nostr identity pubkey of sender>, + "content": <serialized Welcome object>, + "tags": [ + ["e", <ID of the KeyPackage Event used to add the user to the group>], + ["relays", <array of relay urls>], + ], + "sig": <NOT SIGNED> +} +``` + +- The `content` field is required and is a serialized MLSMessage object containing the MLS `Welcome` object. +- The `e` tag is required and is the ID of the KeyPackage Event used to add the user to the group. +- The `relays` tag is required and is a list of relays clients should query for Group Events. + +Welcome Events are then sealed and gift-wrapped as detailed in [NIP-59](59.md) before being published. Like all events that are sealed and gift-wrapped, `kind: 444` events MUST never be signed. This ensures that if they were ever leaked they would not be publishable to relays. + +#### Large Groups + +For groups above ~150 participants, welcome messages will become larger than the maximum event size allowed by Nostr. There is currently work underway on the MLS protocol to support "light" client welcomes that don't require the full Ratchet Tree state to be sent to the new member. This section will be updated with recommendations for how to handle large groups. + +## Group Events + +Group Events are all the messages that are sent within a group. This includes all "control" events that update the shared group state over time (`Proposal`, `Commit`) and messages sent between members of the group (`Application` messages). + +Group Events are published using an ephemeral Nostr keypair to obfuscate the number and identity of group participants. Clients MUST use a new Nostr keypair for each Group Event they publish. + +```json +{ + "id": <id>, + "kind": 445, + "created_at": <unix timestamp in seconds>, + "pubkey": <ephemeral sender pubkey>, + "content": <NIP-44 encrypted serialized MLSMessage object>, + "tags": [ + ["h", <group id>] + ], + "sig": <signed with ephemeral sender key> +} +``` +- The `content` field is a [tls-style](https://www.rfc-editor.org/rfc/rfc9420.html#name-the-message-mls-media-type) serialized [`MLSMessage`](https://www.rfc-editor.org/rfc/rfc9420.html#section-6-4) object which is then encrypted according to [NIP-44](44.md). However, instead of using the sender and receivers keys to derive a `conversation_key`, the NIP-44 encryption is done using a Nostr keypair generated from the MLS [`exporter_secret`](https://www.rfc-editor.org/rfc/rfc9420.html#section-8.5) to calculate the `conversation_key` value. Essentially, you use the hex-encoded `exporter_secret` value as the private key (used as the sender key), calculate the public key for that private key (used as the receiver key), and then proceed with the standard NIP-44 scheme to encrypt and decrypt messages. +- The `exporter_secret` value should be generated with a 32-byte length and labeled `nostr`. This `exporter_secret` value is rotated on each new epoch in the group. Clients should generate a new 32-byte value each time they process a valid `Commit` message. +- The `pubkey` is the hex-encoded public key of the ephemeral sender. +- The `h` tag is the nostr group ID value (from the Nostr Group Data Extension). + +### Application Messages + +Application messages are the messages that are sent within the group by members. These are contained within the `MLSMessage` object. The format of these messages should be unsigned Nostr events of the appropriate kind. For normal DM or group messages, clents SHOULD use `kind: 9` chat message events. If the user reacts to a message, it would be a `kind: 7` event, and so on. + +This means that once the application message has been decrypted and deserialized, clients can store those events and treat them as any other Nostr event, effectively creating a private Nostr feed of the group's activity and taking advantage of all the features of Nostr. + +These inner unsigned Nostr events MUST use the member's Nostr identity key for the `pubkey` field and clients MUST check that the identity of them member who sent the message matches the pubkey of the inner Nostr event. + +These Nostr events MUST remain **unsigned** to ensure that if they were to leak to relays they would not be published publicly. These Nostr events MUST not include any "h" tags or other tags that would identify the group that they belong to. + +### `Commit` Message race conditions + +The MLS protocol is resilient to almost all messages arriving out of order. However, the order of `Commit` messages is important for the group state to move forward from one epoch to the next correctly. Given Nostr's nature as a decentralized network, it is possible for a client to receive 2 or more `Commit` messages all attempting to update to a new epoch at the same time. + +Clients sending commit messages MUST wait until they receive acknowledgement from at least one relay that their Group Message Event with the `Commit` has been received before applying the commit to their own group state. + +If a client receives 2 or more `Commit` messages attempting to change same epoch, they MUST apply only one of the `Commit` messages they receive, determined by the following: + +1. Using the `created_at` timestamp on the kind `445` event. The `Commit` with the lowest value for `created_at` is the message to be applied. The other `Commit` message is discarded. +2. If the `created_at` timestamp is the same for two or more `Commit` messages, the `Commit` message with the lowest value for `id` field is the message to be applied. + +Clients SHOULD retain previous group state for a short period of time in order to recover from forked group state. diff --git a/docs/nips/README.md b/docs/nips/README.md new file mode 100644 index 00000000..445876e1 --- /dev/null +++ b/docs/nips/README.md @@ -0,0 +1,423 @@ +# NIPs + +NIPs stand for **Nostr Implementation Possibilities**. + +They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software. + +--- + +- [List](#list) +- [Event Kinds](#event-kinds) +- [Message Types](#message-types) + - [Client to Relay](#client-to-relay) + - [Relay to Client](#relay-to-client) +- [Common Tags](#common-tags) +- [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) +- [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) +- [How this repository works](#how-this-repository-works) +- [License](#license) + +--- + +## List + +- [NIP-01: Basic protocol flow description](01.md) +- [NIP-02: Follow List](02.md) +- [NIP-03: OpenTimestamps Attestations for Events](03.md) +- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md) +- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) +- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) +- [NIP-07: `window.nostr` capability for web browsers](07.md) +- [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) +- [NIP-09: Event Deletion Request](09.md) +- [NIP-10: Text Notes and Threads](10.md) +- [NIP-11: Relay Information Document](11.md) +- [NIP-13: Proof of Work](13.md) +- [NIP-14: Subject tag in text events](14.md) +- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) +- [NIP-17: Private Direct Messages](17.md) +- [NIP-18: Reposts](18.md) +- [NIP-19: bech32-encoded entities](19.md) +- [NIP-21: `nostr:` URI scheme](21.md) +- [NIP-22: Comment](22.md) +- [NIP-23: Long-form Content](23.md) +- [NIP-24: Extra metadata fields and tags](24.md) +- [NIP-25: Reactions](25.md) +- [NIP-26: Delegated Event Signing](26.md) --- **unrecommended**: adds unnecessary burden for little gain +- [NIP-27: Text Note References](27.md) +- [NIP-28: Public Chat](28.md) +- [NIP-29: Relay-based Groups](29.md) +- [NIP-30: Custom Emoji](30.md) +- [NIP-31: Dealing with Unknown Events](31.md) +- [NIP-32: Labeling](32.md) +- [NIP-34: `git` stuff](34.md) +- [NIP-35: Torrents](35.md) +- [NIP-36: Sensitive Content](36.md) +- [NIP-37: Draft Events](37.md) +- [NIP-38: User Statuses](38.md) +- [NIP-39: External Identities in Profiles](39.md) +- [NIP-40: Expiration Timestamp](40.md) +- [NIP-42: Authentication of clients to relays](42.md) +- [NIP-44: Encrypted Payloads (Versioned)](44.md) +- [NIP-45: Counting results](45.md) +- [NIP-46: Nostr Remote Signing](46.md) +- [NIP-47: Nostr Wallet Connect](47.md) +- [NIP-48: Proxy Tags](48.md) +- [NIP-49: Private Key Encryption](49.md) +- [NIP-50: Search Capability](50.md) +- [NIP-51: Lists](51.md) +- [NIP-52: Calendar Events](52.md) +- [NIP-53: Live Activities](53.md) +- [NIP-54: Wiki](54.md) +- [NIP-55: Android Signer Application](55.md) +- [NIP-56: Reporting](56.md) +- [NIP-57: Lightning Zaps](57.md) +- [NIP-58: Badges](58.md) +- [NIP-59: Gift Wrap](59.md) +- [NIP-60: Cashu Wallet](60.md) +- [NIP-61: Nutzaps](61.md) +- [NIP-62: Request to Vanish](62.md) +- [NIP-64: Chess (PGN)](64.md) +- [NIP-65: Relay List Metadata](65.md) +- [NIP-66: Relay Discovery and Liveness Monitoring](66.md) +- [NIP-68: Picture-first feeds](68.md) +- [NIP-69: Peer-to-peer Order events](69.md) +- [NIP-70: Protected Events](70.md) +- [NIP-71: Video Events](71.md) +- [NIP-72: Moderated Communities](72.md) +- [NIP-73: External Content IDs](73.md) +- [NIP-75: Zap Goals](75.md) +- [NIP-77: Negentropy Syncing](77.md) +- [NIP-78: Application-specific data](78.md) +- [NIP-7D: Threads](7D.md) +- [NIP-84: Highlights](84.md) +- [NIP-86: Relay Management API](86.md) +- [NIP-87: Ecash Mint Discoverability](87.md) +- [NIP-88: Polls](88.md) +- [NIP-89: Recommended Application Handlers](89.md) +- [NIP-90: Data Vending Machines](90.md) +- [NIP-92: Media Attachments](92.md) +- [NIP-94: File Metadata](94.md) +- [NIP-96: HTTP File Storage Integration](96.md) --- **unrecommended**: replaced by blossom APIs +- [NIP-98: HTTP Auth](98.md) +- [NIP-99: Classified Listings](99.md) +- [NIP-A0: Voice Messages](A0.md) +- [NIP-B0: Web Bookmarks](B0.md) +- [NIP-B7: Blossom](B7.md) +- [NIP-C0: Code Snippets](C0.md) +- [NIP-C7: Chats](C7.md) +- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) + +## Event Kinds +| kind | description | NIP | +| ------------- | ------------------------------- | -------------------------------------- | +| `0` | User Metadata | [01](01.md) | +| `1` | Short Text Note | [10](10.md) | +| `2` | Recommend Relay | 01 (deprecated) | +| `3` | Follows | [02](02.md) | +| `4` | Encrypted Direct Messages | [04](04.md) | +| `5` | Event Deletion Request | [09](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `9` | Chat Message | [C7](C7.md) | +| `10` | Group Chat Threaded Reply | 29 (deprecated) | +| `11` | Thread | [7D](7D.md) | +| `12` | Group Thread Reply | 29 (deprecated) | +| `13` | Seal | [59](59.md) | +| `14` | Direct Message | [17](17.md) | +| `15` | File Message | [17](17.md) | +| `16` | Generic Repost | [18](18.md) | +| `17` | Reaction to a website | [25](25.md) | +| `20` | Picture | [68](68.md) | +| `21` | Video Event | [71](71.md) | +| `22` | Short-form Portrait Video Event | [71](71.md) | +| `30` | internal reference | [NKBIP-03] | +| `31` | external web reference | [NKBIP-03] | +| `32` | hardcopy reference | [NKBIP-03] | +| `33` | prompt reference | [NKBIP-03] | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `62` | Request to Vanish | [62](62.md) | +| `64` | Chess (PGN) | [64](64.md) | +| `443` | KeyPackage | [EE](EE.md) | +| `444` | Welcome Message | [EE](EE.md) | +| `445` | Group Event | [EE](EE.md) | +| `818` | Merge Requests | [54](54.md) | +| `1018` | Poll Response | [88](88.md) | +| `1021` | Bid | [15](15.md) | +| `1022` | Bid confirmation | [15](15.md) | +| `1040` | OpenTimestamps | [03](03.md) | +| `1059` | Gift Wrap | [59](59.md) | +| `1063` | File Metadata | [94](94.md) | +| `1068` | Poll | [88](88.md) | +| `1111` | Comment | [22](22.md) | +| `1222` | Voice Message | [A0](A0.md) | +| `1244` | Voice Message Comment | [A0](A0.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1337` | Code Snippet | [C0](C0.md) | +| `1617` | Patches | [34](34.md) | +| `1618` | Pull Requests | [34](34.md) | +| `1619` | Pull Request Updates | [34](34.md) | +| `1621` | Issues | [34](34.md) | +| `1622` | Git Replies (deprecated) | [34](34.md) | +| `1630`-`1633` | Status | [34](34.md) | +| `1971` | Problem Tracker | [nostrocket][nostrocket] | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `1986` | Relay reviews | | +| `1987` | AI Embeddings / Vector lists | [NKBIP-02] | +| `2003` | Torrent | [35](35.md) | +| `2004` | Torrent Comment | [35](35.md) | +| `2022` | Coinjoin Pool | [joinstr][joinstr] | +| `4550` | Community Post Approval | [72](72.md) | +| `5000`-`5999` | Job Request | [90](90.md) | +| `6000`-`6999` | Job Result | [90](90.md) | +| `7000` | Job Feedback | [90](90.md) | +| `7374` | Reserved Cashu Wallet Tokens | [60](60.md) | +| `7375` | Cashu Wallet Tokens | [60](60.md) | +| `7376` | Cashu Wallet History | [60](60.md) | +| `7516` | Geocache log | [geocaching][geocaching] | +| `7517` | Geocache proof of find | [geocaching][geocaching] | +| `9000`-`9030` | Group Control Events | [29](29.md) | +| `9041` | Zap Goal | [75](75.md) | +| `9321` | Nutzap | [61](61.md) | +| `9467` | Tidal login | [Tidal-nostr] | +| `9734` | Zap Request | [57](57.md) | +| `9735` | Zap | [57](57.md) | +| `9802` | Highlights | [84](84.md) | +| `10000` | Mute list | [51](51.md) | +| `10001` | Pin list | [51](51.md) | +| `10002` | Relay List Metadata | [65](65.md), [51](51.md) | +| `10003` | Bookmark list | [51](51.md) | +| `10004` | Communities list | [51](51.md) | +| `10005` | Public chats list | [51](51.md) | +| `10006` | Blocked relays list | [51](51.md) | +| `10007` | Search relays list | [51](51.md) | +| `10009` | User groups | [51](51.md), [29](29.md) | +| `10012` | Favorite relays list | [51](51.md) | +| `10013` | Private event relay list | [37](37.md) | +| `10015` | Interests list | [51](51.md) | +| `10019` | Nutzap Mint Recommendation | [61](61.md) | +| `10020` | Media follows | [51](51.md) | +| `10030` | User emoji list | [51](51.md) | +| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | +| `10051` | KeyPackage Relays List | [EE](EE.md) | +| `10063` | User server list | [Blossom][blossom] | +| `10096` | File storage server list | [96](96.md) (deprecated) | +| `10166` | Relay Monitor Announcement | [66](66.md) | +| `10312` | Room Presence | [53](53.md) | +| `10377` | Proxy Announcement | [Nostr Epoxy][nostr-epoxy] | +| `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] | +| `13194` | Wallet Info | [47](47.md) | +| `17375` | Cashu Wallet Event | [60](60.md) | +| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | +| `22242` | Client Authentication | [42](42.md) | +| `23194` | Wallet Request | [47](47.md) | +| `23195` | Wallet Response | [47](47.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `24242` | Blobs stored on mediaservers | [Blossom][blossom] | +| `27235` | HTTP Auth | [98](98.md) | +| `30000` | Follow sets | [51](51.md) | +| `30001` | Generic lists | 51 (deprecated) | +| `30002` | Relay sets | [51](51.md) | +| `30003` | Bookmark sets | [51](51.md) | +| `30004` | Curation sets | [51](51.md) | +| `30005` | Video sets | [51](51.md) | +| `30007` | Kind mute sets | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30015` | Interest sets | [51](51.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30019` | Marketplace UI/UX | [15](15.md) | +| `30020` | Product sold as an auction | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.md) | +| `30030` | Emoji sets | [51](51.md) | +| `30040` | Curated Publication Index | [NKBIP-01] | +| `30041` | Curated Publication Content | [NKBIP-01] | +| `30063` | Release artifact sets | [51](51.md) | +| `30078` | Application-specific Data | [78](78.md) | +| `30166` | Relay Discovery | [66](66.md) | +| `30267` | App curation sets | [51](51.md) | +| `30311` | Live Event | [53](53.md) | +| `30312` | Interactive Room | [53](53.md) | +| `30313` | Conference Event | [53](53.md) | +| `30315` | User Statuses | [38](38.md) | +| `30388` | Slide Set | [Corny Chat][cornychat-slideset] | +| `30402` | Classified Listing | [99](99.md) | +| `30403` | Draft Classified Listing | [99](99.md) | +| `30617` | Repository announcements | [34](34.md) | +| `30618` | Repository state announcements | [34](34.md) | +| `30818` | Wiki article | [54](54.md) | +| `30819` | Redirects | [54](54.md) | +| `31234` | Draft Event | [37](37.md) | +| `31388` | Link Set | [Corny Chat][cornychat-linkset] | +| `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] | +| `31922` | Date-Based Calendar Event | [52](52.md) | +| `31923` | Time-Based Calendar Event | [52](52.md) | +| `31924` | Calendar | [52](52.md) | +| `31925` | Calendar Event RSVP | [52](52.md) | +| `31989` | Handler recommendation | [89](89.md) | +| `31990` | Handler information | [89](89.md) | +| `32267` | Software Application | | +| `34550` | Community Definition | [72](72.md) | +| `38172` | Cashu Mint Announcement | [87](87.md) | +| `38173` | Fedimint Announcement | [87](87.md) | +| `37516` | Geocache listing | [geocaching](geocaching) | +| `38383` | Peer-to-peer Order events | [69](69.md) | +| `39000-9` | Group metadata events | [29](29.md) | +| `39089` | Starter packs | [51](51.md) | +| `39092` | Media starter packs | [51](51.md) | +| `39701` | Web bookmarks | [B0](B0.md) | + +[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ +[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md +[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md +[cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset +[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset +[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md +[NKBIP-01]: https://wikistr.com/nkbip-01*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 +[NKBIP-02]: https://wikistr.com/nkbip-02*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 +[NKBIP-03]: https://wikistr.com/nkbip-03*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 +[blossom]: https://github.com/hzrd149/blossom +[Tidal-nostr]: https://wikistr.com/tidal-nostr +[geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5 +[nostr-epoxy]: https://github.com/Origami74/nostr-epoxy-reverse-proxy + +## Message types + +### Client to Relay + +| type | description | NIP | +| ------- | --------------------------------------------------- | ----------- | +| `EVENT` | used to publish events | [01](01.md) | +| `REQ` | used to request events and subscribe to new updates | [01](01.md) | +| `CLOSE` | used to stop previous subscriptions | [01](01.md) | +| `AUTH` | used to send authentication events | [42](42.md) | +| `COUNT` | used to request event counts | [45](45.md) | + +### Relay to Client + +| type | description | NIP | +| -------- | ------------------------------------------------------- | ----------- | +| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) | +| `EVENT` | used to send events requested to clients | [01](01.md) | +| `NOTICE` | used to send human-readable messages to clients | [01](01.md) | +| `OK` | used to notify clients if an EVENT was successful | [01](01.md) | +| `CLOSED` | used to notify clients that a REQ was ended and why | [01](01.md) | +| `AUTH` | used to send authentication challenges | [42](42.md) | +| `COUNT` | used to send requested event counts to clients | [45](45.md) | + +## Common Tags + +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `A` | root address | relay URL | [22](22.md) | +| `c` | commit id | | [34](34.md) | +| `d` | identifier | -- | [01](01.md) | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | +| `E` | root event id | relay URL | [22](22.md) | +| `f` | currency code | -- | [69](69.md) | +| `g` | geohash | -- | [52](52.md) | +| `h` | group id | -- | [29](29.md) | +| `i` | external identity | proof, url hint | [35](35.md), [39](39.md), [73](73.md) | +| `I` | root external identity | -- | [22](22.md) | +| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | +| `K` | root scope | -- | [22](22.md) | +| `l` | label, label namespace, language name| -- | [32](32.md), [C0](C0.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md), [22](22.md) | +| `P` | pubkey (hex) | -- | [22](22.md), [57](57.md) | +| `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | +| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | +| `r` | relay url | marker | [65](65.md) | +| `s` | status | -- | [69](69.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) | +| `u` | url | -- | [61](61.md), [98](98.md) | +| `x` | hash | -- | [35](35.md), [56](56.md) | +| `y` | platform | -- | [69](69.md) | +| `z` | order number | -- | [69](69.md) | +| `-` | -- | -- | [70](70.md) | +| `alt` | summary | -- | [31](31.md) | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `branch-name` | branch name suggestion | -- | [34](34.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `client` | name, address | relay URL | [89](89.md) | +| `clone` | git clone URL | -- | [34](34.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `dep` | Required dependency | -- | [C0](C0.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md), [C0](C0.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `encrypted` | -- | -- | [90](90.md) | +| `extension` | File extension | -- | [C0](C0.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `file` | full path (string) | -- | [35](35.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | +| `merge-base` | commit id | | [34](34.md) | +| `HEAD` | `ref: refs/heads/<branch-name>` | | [34](34.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | +| `imeta` | inline metadata | -- | [92](92.md) | +| `license` | License of the shared content | -- | [C0](C0.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md), [C0](C0.md) | +| `nonce` | random | difficulty | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md), [B0](B0.md) | +| `relay` | relay url | -- | [42](42.md), [17](17.md) | +| `relays` | relay list | -- | [57](57.md) | +| `repo` | Reference to the origin repository | -- | [C0](C0.md) | +| `runtime` | Runtime or environment specification | -- | [C0](C0.md) | +| `server` | file storage server url | -- | [96](96.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | +| `summary` | summary | -- | [23](23.md), [52](52.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | title | -- | [23](23.md), [B0](B0.md) | +| `tracker` | torrent tracker URL | -- | [35](35.md) | +| `web` | webpage URL | -- | [34](34.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | + +Please update these lists when proposing new NIPs. + +## Criteria for acceptance of NIPs + +1. They should be fully implemented in at least two clients and one relay -- when applicable. +2. They should make sense. +3. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to. +4. There should be no more than one way of doing the same thing. +5. Other rules will be made up when necessary. + +## Is this repository a centralizing factor? + +To promote interoperability, we need standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such an index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. + +It can even fork into multiple versions, and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. + +There is a list of notable Nostr software developers who have commit access to this repository, but that exists mostly for practical reasons, as by the nature of the thing we're dealing with the repository owner can revoke membership and rewrite history as they want -- and if these actions are unjustified or perceived as bad or evil the community must react. + +## How this repository works + +Standards may emerge in two ways: the first way is that someone starts doing something, then others copy it; the second way is that someone has an idea of a new standard that could benefit multiple clients and the protocol in general without breaking **backwards-compatibility** and the principle of having **a single way of doing things**, then they write that idea and submit it to this repository, other interested parties read it and give their feedback, then once most people reasonably agree we codify that in a NIP which client and relay developers that are interested in the feature can proceed to implement. + +These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful. + +## License + +All NIPs are public domain. + +## Contributors + +<a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors"> + <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" /> +</a> diff --git a/docs/nostr-event-schemas.md b/docs/nostr-event-schemas.md index cc0149b3..77f4319e 100644 --- a/docs/nostr-event-schemas.md +++ b/docs/nostr-event-schemas.md @@ -138,20 +138,33 @@ import { updateWatchHistoryListWithDefaultClient } from "./nostrWatchHistoryFaca | Video post (`NOTE_TYPES.VIDEO_POST`) | `30078` | `['t','video']`, `['d', <stable video identifier>]` plus optional schema append tags | JSON payload using Content Schema v3 (`version`, `title`, optional `url`, `magnet`, `thumbnail`, `description`, `mode`, `videoRootId`, `deleted`, `isPrivate`, `isNsfw`, `isForKids`, `enableComments`, `ws`, `xs`) | | NIP-94 mirror (`NOTE_TYPES.VIDEO_MIRROR`) | `1063` | Tags forwarded from `publishVideo` (URL, mime type, thumbnail, alt text, magnet) | Plain text alt description | | Repost (`NOTE_TYPES.REPOST`) | `6` | `['e', <event id>, <relay?>]` with optional address pointer `['a', <kind:pubkey:identifier>, <relay?>]`, and `['p', <pubkey>]` when the origin author is known; inherits schema append tags | Empty content | -| Video comment (`NOTE_TYPES.VIDEO_COMMENT`) | `1` | Mandatory `['e', <video event id>, <relay?>?]` and `['a', <kind:pubkey:identifier>, <relay?>?]` tags, optional parent pointers `['e', <parent comment id>, <relay?>?]`, and optional participant markers `['p', <pubkey>, <relay?>?]`; inherits schema append tags | Plain text body sanitized to valid UTF-8 | +| Video comment (`NOTE_TYPES.VIDEO_COMMENT`) | `1111` | NIP-22 root scope tags `['A'\|`E`\|`I`, <pointer>, <relay?>?], `['K', <root kind>]`, and `['P', <root author pubkey>, <relay?>?]` plus parent metadata `['a'\|`e`\|`i`, <parent pointer>, <relay?>?, <author?>], `['k', <parent kind>]`, `['p', <parent author>, <relay?>?]`; builder retains legacy lowercase fallbacks (`['a', ...]`/`['e', ...]`/`['p', ...]`) alongside the uppercase set for compatibility; inherits schema append tags | Plain text body sanitized to valid UTF-8 | + +> **Publishing note:** Session actors only emit passive telemetry (for example, view counters) and must **not** sign video comments. Require a logged-in Nostr signer for comment publishing via [`commentEvents`](../js/nostr/commentEvents.js). + +> **Compatibility tip:** When a comment anchors itself to a video definition address, emit both the uppercase root pointer and a legacy `['e', <root event id>]` tag. This mirrors the [NIP-22 addressable events example](./nips/22.md#addressable-events) so clients that only understand `#e` tags can still follow the thread. | NIP-71 video (`NOTE_TYPES.NIP71_VIDEO`) | `21` | `['title', <title>]`, optional `['published_at', <unix seconds>]`, optional `['alt', <text>]`, repeated `['imeta', ...]` entries describing NIP-92 media variants, optional `['duration', <seconds>]`, repeated `['text-track', <url>, <kind>, <language>]`, optional `['content-warning', <reason>]`, repeated `['segment', <start>, <end>, <title>, <thumbnail>]`, repeated hashtags `['t', <tag>]`, repeated participants `['p', <pubkey>, <relay?>]`, repeated references `['r', <url>]` | Plain text summary carried in the content field. Publishing is gated by the `FEATURE_PUBLISH_NIP71` runtime flag while the rollout stabilizes. | | NIP-71 short video (`NOTE_TYPES.NIP71_SHORT_VIDEO`) | `22` | Same as `NOTE_TYPES.NIP71_VIDEO`; the kind differentiates short-form presentations. | Plain text summary; gated by `FEATURE_PUBLISH_NIP71`. | | Relay list (`NOTE_TYPES.RELAY_LIST`) | `10002` | Repeating `['r', <relay url>]` tags, optionally with a marker of `'read'` or `'write'` to scope the relay; marker omitted for read/write relays | Empty content | | View counter (`NOTE_TYPES.VIEW_EVENT`) | `WATCH_HISTORY_KIND` (default `30079`, clients also read legacy `30078`) | Canonical tag set: `['t','view']`, a pointer tag (`['e', <eventId>]` or `['a', <address>]`), and a stable dedupe tag `['d', <view identifier>]`, with optional `['session','true']` when a session actor signs; schema overrides may append extra tags. `['video', ...]` is supported for legacy overrides only. | Optional plaintext message | | Watch history index (`NOTE_TYPES.WATCH_HISTORY_INDEX`) | `WATCH_HISTORY_KIND` (default `30079`, clients also read legacy `30078`) | `['d', WATCH_HISTORY_LIST_IDENTIFIER]`, `['snapshot', <id>]`, `['chunks', <total>]`, repeated `['a', <chunk address>]` pointers plus schema append tags | JSON payload `{ snapshot, totalChunks }` (may be empty when using tags only) | | Watch history chunk (`NOTE_TYPES.WATCH_HISTORY_CHUNK`) | `WATCH_HISTORY_KIND` (default `30079`, clients also read legacy `30078`) | `['d', <snapshotId:index>]`, `['encrypted','nip04']`, `['snapshot', <id>]`, `['chunk', <index>, <total>]`, optional leading `['head','1']` on the first chunk, pointer tags for each item, plus schema append tags | NIP-04 encrypted JSON chunk (`{ version, snapshot, chunkIndex, totalChunks, items[] }`) | -| Subscription list (`NOTE_TYPES.SUBSCRIPTION_LIST`) | `30002` | `['d', 'subscriptions']` | NIP-04 encrypted JSON `{ subPubkeys: string[] }` | -| User block list (`NOTE_TYPES.USER_BLOCK_LIST`) | `30002` | `['d', 'user-blocks']` | NIP-04 encrypted JSON `{ blockedPubkeys: string[] }` | +| Subscription list (`NOTE_TYPES.SUBSCRIPTION_LIST`) | `30000` (clients also read legacy `30002`) | `['d', 'subscriptions']` | NIP-04/NIP-44 encrypted JSON array of NIP-51 follow-set tuples (e.g., `[['p', <hex>], …]`) | +| User block list (`NOTE_TYPES.USER_BLOCK_LIST`) | `10000` | `['d', 'user-blocks']` | NIP-04/NIP-44 encrypted JSON `{ blockedPubkeys: string[] }` | | Hashtag preferences (`NOTE_TYPES.HASHTAG_PREFERENCES`) | `30005` | `['d', 'bitvid:tag-preferences']` plus schema-appended `['encrypted','nip44_v2']` | NIP-44 encrypted JSON `{ version, interests: string[], disinterests: string[] }` | | Admin moderation list (`NOTE_TYPES.ADMIN_MODERATION_LIST`) | `30000` | `['d', 'bitvid:admin:editors']`, repeated `['p', <pubkey>]` entries | Empty content | | Admin blacklist (`NOTE_TYPES.ADMIN_BLACKLIST`) | `30000` | `['d', 'bitvid:admin:blacklist']`, repeated `['p', <pubkey>]` entries | Empty content | | Admin whitelist (`NOTE_TYPES.ADMIN_WHITELIST`) | `30000` | `['d', 'bitvid:admin:whitelist']`, repeated `['p', <pubkey>]` entries | Empty content | +Subscription lists therefore match the +[NIP-51 follow-set specification](./nips/51.md#sets) by emitting kind `30000` +events with the shared `['d','subscriptions']` identifier. Builders continue to +encrypt the payload so individual follows stay private unless explicitly +revealed by the author. Readers still request legacy kind `30002` alongside +`30000` while older clients migrate so existing follow sets remain visible. + +NIP-94 compliance: mirror events now normalize the `['m', <mime>]` tag to lowercase—covering both user input and inferred values—so they satisfy [NIP-94's lowercase MIME requirement](./nips/94.md). Related helpers reuse the same normalization to keep future publishers aligned. + ### Direct messages bitvid now consumes both legacy direct messages (kind `4`) and modern gift-wrap envelopes (kind `1059`). The `js/dmDecryptor.js` helper unwraps these events by: @@ -208,10 +221,13 @@ Active identifiers include the default `WATCH_HISTORY_LIST_IDENTIFIER` `WATCH_HISTORY_LEGACY_LIST_IDENTIFIERS`. Chunk events derive their `d` tag from `<snapshotId>:<index>`, advertise `['snapshot', <id>]`, and carry `['chunk', <index>, <total>]` plus an optional leading `['head','1']` marker so relays can prioritize the first -ciphertext. All chunk content is encrypted with NIP-04 and stores only pointer -entries; richer metadata remains on-device via the -[`WatchHistoryService`](../js/watchHistoryService.js) APIs, which default to -pointer-only writes and local-only metadata caches.【F:config/instance-config.js†L60-L78】【F:js/nostrEventSchemas.js†L157-L189】【F:js/nostr/watchHistory.js†L1343-L1400】【F:js/watchHistoryService.js†L331-L376】 +ciphertext. Chunk content is encrypted with the strongest mutually supported +scheme: clients probe for NIP-44 v2 first, fall back to NIP-44, and finally use +NIP-04 for legacy compatibility. The negotiated value is written back to the +`['encrypted', ...]` tag so other readers can attempt the same scheme before +falling back. All payloads store only pointer entries; richer metadata remains +on-device via the [`WatchHistoryService`](../js/watchHistoryService.js) APIs, +which default to pointer-only writes and local-only metadata caches.【F:config/instance-config.js†L60-L78】【F:js/nostrEventSchemas.js†L157-L189】【F:js/nostr/watchHistory.js†L1380-L1549】【F:js/watchHistoryService.js†L331-L376】 Refer to the [`WatchHistoryService`](../js/watchHistoryService.js) for queue management hooks, manual snapshot helpers, and metadata toggle controls that diff --git a/docs/nwc-compliance.md b/docs/nwc-compliance.md index 8fc9fb7e..69524db2 100644 --- a/docs/nwc-compliance.md +++ b/docs/nwc-compliance.md @@ -8,13 +8,15 @@ specification so we can quickly spot regressions or missing features. * `parseNwcUri()` accepts all aliases we see in the wild (`nostr+walletconnect://`, `walletconnect://`, and `nwc://`) and rejects unknown schemes before continuing. It extracts the wallet pubkey, all relay query parameters, and the 32-byte secret required for signing. The helper lowercases the secret, reserializes the URI in canonical form, and - derives the client public key from the secret so downstream calls can sign events without leaking user keys. + derives the client public key from the secret so downstream calls can sign events without leaking user keys. It also + surfaces any connection `budget` (in msats) plus renewal metadata from the query parameters so callers can enforce + wallet allowances consistently. ## Connection lifecycle * `ensureActiveState()` caches the parsed connection and keeps WebSocket state so repeated actions reuse the same - subscription. When a new URI is supplied we tear down the previous socket, update the relay list, and reset - encryption state before reconnecting. + subscription. When a new URI is supplied we tear down the previous socket, update the relay list, reset encryption + state, and initialize a per-connection budget tracker (spent vs. total) before reconnecting. * `connectSocket()` opens a WebSocket to the relay, subscribes to kind `23195` responses authored by the wallet and addressed to the client pubkey, and hooks message/error/close callbacks so we can retry or surface failures. @@ -26,7 +28,10 @@ specification so we can quickly spot regressions or missing features. Nostr event with kind `23194`, `pubkey` set to the client key, a `p` tag pointing at the wallet, and an `encryption` tag mirroring the algorithm that was used. Events are signed with the secret from the connection URI so relays will accept them. -* `sendPayment()` constructs the `pay_invoice` request, attaches a unique `id`, and dispatches it over the relay. +* `sendPayment()` resolves the msat amount that will be charged (from explicit params or by decoding the invoice), + compares it against the remaining budget, and short-circuits with a `NWC_BUDGET_EXHAUSTED` error when the new spend would + exceed the allowance. Successful payments increment the tracked spend, and wallet responses that report allowance + exhaustion mark the tracker as depleted so follow-up requests fail fast. ## Response flow diff --git a/docs/release-notes.md b/docs/release-notes.md new file mode 100644 index 00000000..fdebf0cf --- /dev/null +++ b/docs/release-notes.md @@ -0,0 +1,12 @@ +# Release Notes + +## 2025-11-04 + +- **WebTorrent tracker refresh:** Updated the default browser-safe tracker pool in + [`js/constants.js`](../js/constants.js) to swap out the failing `tracker.fastcast.nz`, + `tracker.webtorrent.dev`, and `tracker.sloppyta.co` endpoints. The new roster is: + `wss://tracker.openwebtorrent.com`, `wss://tracker.ghostchu-services.top:443/announce`, + `wss://tracker.files.fm:7073/announce`, `wss://tracker.dler.org:443/announce`, + `wss://tracker.btorrent.xyz`, and `wss://tracker.novage.com.ua:443/announce`. Operators + who override the runtime `WSS_TRACKERS` flag should update their configs to match so + magnet fallback continues to connect without churn. diff --git a/js/accessControl.js b/js/accessControl.js index 02706d89..0ac932dc 100644 --- a/js/accessControl.js +++ b/js/accessControl.js @@ -130,6 +130,13 @@ class AccessControl { } }; + // Attempt a synchronous hydration so downstream consumers (like + // bootstrapTrustedSeeds) have immediate access to any cached admin + // state before they trigger refresh logic. This avoids a race where the + // async microtask hydration hasn't executed yet when those consumers + // call into `refresh()` and encounter an empty cache. + runHydrate(); + if (typeof queueMicrotask === "function") { queueMicrotask(runHydrate); return; @@ -140,7 +147,15 @@ class AccessControl { _hydrateFromCache() { this._hydratedFromCache = false; - const cachedState = readCachedAdminState(); + let cachedState = null; + try { + cachedState = readCachedAdminState(); + } catch (error) { + if (error && error.name === "ReferenceError") { + return; + } + throw error; + } if (cachedState) { this._applyState(cachedState, { markLoaded: false }); this._hydratedFromCache = true; @@ -750,6 +765,7 @@ class AccessControl { } export const accessControl = new AccessControl(); +export default accessControl; export { AccessControl, ADMIN_WHITELIST_MODE_STORAGE_KEY, diff --git a/js/adminListStore.js b/js/adminListStore.js index edec5d88..ef9c83fa 100644 --- a/js/adminListStore.js +++ b/js/adminListStore.js @@ -276,7 +276,7 @@ function loadLegacyAdminState() { return hasAnyEntries(sanitized) ? sanitized : null; } -export function readCachedAdminState() { +export const readCachedAdminState = () => { if (typeof localStorage === "undefined") { return null; } @@ -306,9 +306,9 @@ export function readCachedAdminState() { ); return null; } -} +}; -export function writeCachedAdminState(state) { +export const writeCachedAdminState = (state) => { if (typeof localStorage === "undefined") { return; } @@ -322,7 +322,7 @@ export function writeCachedAdminState(state) { error, ); } -} +}; function clearLegacyStorageFor(listKey) { if (typeof localStorage === "undefined") { diff --git a/js/app.js b/js/app.js index 70c33279..e4292b61 100644 --- a/js/app.js +++ b/js/app.js @@ -27,6 +27,7 @@ import { attachHealthBadges } from "./gridHealth.js"; import { attachUrlHealthBadges } from "./urlHealthObserver.js"; import { updateVideoCardSourceVisibility } from "./utils/cardSourceVisibility.js"; import { collectVideoTags } from "./utils/videoTags.js"; +import { sanitizeProfileMediaUrl } from "./utils/profileMedia.js"; import { ADMIN_INITIAL_EVENT_BLACKLIST } from "./lists.js"; import { userBlocks } from "./userBlocks.js"; import { relayManager } from "./relayManager.js"; @@ -43,8 +44,6 @@ import { } from "./feedEngine/index.js"; import watchHistoryService from "./watchHistoryService.js"; import r2Service from "./services/r2Service.js"; -import PlaybackService from "./services/playbackService.js"; -import AuthService from "./services/authService.js"; import { getVideoNoteErrorMessage, normalizeVideoNotePayload, @@ -52,17 +51,10 @@ import { import getAuthProvider, { providers as authProviders, } from "./services/authProviders/index.js"; -import NwcSettingsService from "./services/nwcSettingsService.js"; -import nostrService from "./services/nostrService.js"; -import DiscussionCountService from "./services/discussionCountService.js"; -import CommentThreadService from "./services/commentThreadService.js"; import hashtagPreferences, { HASHTAG_PREFERENCES_EVENTS, } from "./services/hashtagPreferencesService.js"; import { initQuickR2Upload } from "./r2-quick.js"; -import { createWatchHistoryRenderer } from "./historyView.js"; -import WatchHistoryController from "./ui/watchHistoryController.js"; -import WatchHistoryTelemetry from "./services/watchHistoryTelemetry.js"; import { getSidebarLoadingMarkup } from "./sidebarLoading.js"; import { subscriptions } from "./subscriptions.js"; import { @@ -74,9 +66,6 @@ import { devLogger, userLogger } from "./utils/logger.js"; import createPopover from "./ui/overlay/popoverEngine.js"; import { createVideoSettingsMenuPanel } from "./ui/components/videoMenuRenderers.js"; import moderationService from "./services/moderationService.js"; -import AppChromeController from "./ui/appChromeController.js"; -import VideoListViewController from "./ui/videoListViewController.js"; -import ProfileIdentityController from "./ui/profileIdentityController.js"; import { initViewCounter, subscribeToVideoViewCount, @@ -85,7 +74,6 @@ import { ingestLocalViewEvent, } from "./viewCounter.js"; import { splitAndZap as splitAndZapDefault } from "./payments/zapSplit.js"; -import { showLoginRequiredToZapNotification } from "./payments/zapNotifications.js"; import { formatAbsoluteTimestamp as formatAbsoluteTimestampUtil, formatTimeAgo as formatTimeAgoUtil, @@ -95,28 +83,17 @@ import { import reactionCounter from "./reactionCounter.js"; import { escapeHTML as escapeHtml, - removeTrackingScripts, } from "./utils/domUtils.js"; -import { VideoModal } from "./ui/components/VideoModal.js"; -import { RevertModal } from "./ui/components/RevertModal.js"; import { prepareStaticModal, openStaticModal, closeStaticModal, } from "./ui/components/staticModalAccessibility.js"; -import { VideoListView } from "./ui/views/VideoListView.js"; import createTagPreferenceMenu, { TAG_PREFERENCE_ACTIONS, applyTagPreferenceMenuState, } from "./ui/components/tagPreferenceMenu.js"; -import MoreMenuController from "./ui/moreMenuController.js"; -import ProfileModalController from "./ui/profileModalController.js"; import LoginModalController from "./ui/loginModalController.js"; -import ZapController from "./ui/zapController.js"; -import initUploadModal from "./ui/initUploadModal.js"; -import initEditModal from "./ui/initEditModal.js"; -import initDeleteModal from "./ui/initDeleteModal.js"; -import { MediaLoader } from "./utils/mediaLoader.js"; import { pointerArrayToKey } from "./utils/pointer.js"; import resolveVideoPointer, { buildVideoAddressPointer, @@ -164,13 +141,16 @@ import { URL_PROBE_TIMEOUT_MS, urlHealthConstants, } from "./state/cache.js"; +import ApplicationBootstrap from "./ui/applicationBootstrap.js"; +import VideoModalCommentController from "./ui/videoModalCommentController.js"; +import ModerationActionController from "./services/moderationActionController.js"; const recordVideoViewApi = (...args) => recordVideoView(nostrClient, ...args); const UNSUPPORTED_BTITH_MESSAGE = "This magnet link is missing a compatible BitTorrent v1 info hash."; -const FALLBACK_THUMBNAIL_SRC = "assets/jpg/video-thumbnail-fallback.jpg"; +const FALLBACK_THUMBNAIL_SRC = "/assets/jpg/video-thumbnail-fallback.jpg"; const VIDEO_EVENT_KIND = 30078; const HEX64_REGEX = /^[0-9a-f]{64}$/i; /** @@ -211,1385 +191,35 @@ class Application { constructor({ services = {}, ui = {}, helpers = {}, loadView: viewLoader } = {}) { this.loadView = typeof viewLoader === "function" ? viewLoader : null; - // Basic auth/display elements - this.loginButton = document.getElementById("loginButton") || null; - this.logoutButton = document.getElementById("logoutButton") || null; - this.userStatus = document.getElementById("userStatus") || null; - this.userPubKey = document.getElementById("userPubKey") || null; - - const mediaLoaderFactory = - typeof helpers.mediaLoaderFactory === "function" - ? helpers.mediaLoaderFactory - : () => new MediaLoader(); - this.mediaLoader = - helpers.mediaLoader instanceof MediaLoader - ? helpers.mediaLoader - : mediaLoaderFactory(); - this.loadedThumbnails = new Map(); - this.urlHealthSnapshots = new Map(); - this.streamHealthSnapshots = new Map(); - this.boundStreamHealthBadgeHandler = (detail) => - this.handleStreamHealthBadgeUpdate(detail); - this.attachHealthBadgesWithCache = (container) => { - attachHealthBadges(container, { - onUpdate: this.boundStreamHealthBadgeHandler, - }); + const bootstrapServices = { + ...services, + torrentClient, + deriveTorrentPlaybackConfig, + isValidMagnetUri, + authProviders, + getAuthProvider, }; - this.defaultModerationSettings = getDefaultModerationSettings(); - this.moderationSettings = { ...this.defaultModerationSettings }; - this.relayManager = relayManager; - this.activeIntervals = []; - this.watchHistoryTelemetry = null; - this.authEventUnsubscribes = []; - this.unsubscribeFromNostrService = null; - this.designSystemContext = { - getMode: () => "new", - isNew: () => true, - }; - this.videoModalReadyPromise = null; - this.boundUploadSubmitHandler = null; - this.boundEditModalSubmitHandler = null; - this.boundEditModalCancelHandler = null; - this.boundRevertConfirmHandler = null; - this.boundDeleteConfirmHandler = null; - this.boundDeleteCancelHandler = null; - this.boundVideoModalCloseHandler = null; - this.boundVideoModalCopyHandler = null; - this.boundVideoModalShareHandler = null; - this.boundVideoModalCreatorHandler = null; - this.boundVideoModalZapHandler = null; - this.boundVideoModalZapWalletHandler = null; - this.boundVideoModalCommentSubmitHandler = null; - this.boundVideoModalCommentRetryHandler = null; - this.boundVideoModalCommentLoadMoreHandler = null; - this.boundVideoModalCommentLoginHandler = null; - this.boundVideoModalCommentMuteHandler = null; - this.boundVideoModalTagActivateHandler = null; - this.pendingModalZapOpen = false; - this.videoListViewPlaybackHandler = null; - this.videoListViewEditHandler = null; - this.videoListViewRevertHandler = null; - this.videoListViewDeleteHandler = null; - this.deleteModal = null; - this.moreMenuController = null; - this.latestFeedMetadata = null; - this.lastModalTrigger = null; - this.modalCommentState = { - videoEventId: null, - videoDefinitionAddress: null, - parentCommentId: null, - }; - this.modalCommentProfiles = new Map(); - this.modalCommentLimit = 40; - this.modalCommentLoadPromise = null; - this.modalCommentPublishPromise = null; - this.uploadSubmitPromise = null; - this.pendingModeratedPlayback = null; - this.lastIdentityRefreshPromise = null; - this.profileIdentityController = new ProfileIdentityController({ - callbacks: { - safeEncodeNpub: (pubkey) => this.safeEncodeNpub(pubkey), - formatShortNpub: (value) => formatShortNpub(value), - }, - logger: devLogger, - }); - this.videoListViewController = new VideoListViewController({ - getSidebarLoadingMarkup, - logger: devLogger, - }); - this.appChromeController = null; - this.nostrService = services.nostrService || nostrService; - this.r2Service = services.r2Service || r2Service; - - this.feedEngine = - services.feedEngine || - createFeedEngine({ - logger: (...args) => { - if (!isWatchHistoryDebugEnabled()) { - return; - } - devLogger.info(...args); - }, - }); - this.payments = services.payments || null; - this.splitAndZap = - (services.payments && services.payments.splitAndZap) || - splitAndZapDefault; - - this.discussionCountService = - services.discussionCountService || new DiscussionCountService(); - - this.nwcSettingsService = - services.nwcSettingsService || - new NwcSettingsService({ - normalizeHexPubkey: (value) => this.normalizeHexPubkey(value), - getActivePubkey: () => this.pubkey, - payments: this.payments, - logger: { - warn: (...args) => devLogger.warn(...args), - }, - notifyError: (message) => this.showError(message), - maxWalletDefaultZap: MAX_WALLET_DEFAULT_ZAP, - }); - this.hashtagPreferences = - services.hashtagPreferences || hashtagPreferences; - this.hashtagPreferencesSnapshot = - this.createHashtagPreferencesSnapshot(); - this.hashtagPreferencesSnapshotSignature = - this.computeHashtagPreferencesSignature( - this.hashtagPreferencesSnapshot, - ); - this.hashtagPreferencesPublishInFlight = false; - this.hashtagPreferencesPublishPromise = null; - this.boundHashtagPreferencesChangeHandler = null; - this.unsubscribeFromHashtagPreferencesChange = null; - if ( - this.hashtagPreferences && - typeof this.hashtagPreferences.on === "function" - ) { - this.boundHashtagPreferencesChangeHandler = (detail) => - this.handleHashtagPreferencesChange(detail); - try { - this.unsubscribeFromHashtagPreferencesChange = - this.hashtagPreferences.on( - HASHTAG_PREFERENCES_EVENTS.CHANGE, - this.boundHashtagPreferencesChangeHandler, - ); - } catch (error) { - devLogger.warn( - "[Application] Failed to subscribe to hashtag preferences changes:", - error, - ); - } - } - if ( - this.nwcSettingsService && - typeof this.nwcSettingsService.setActivePubkeyGetter === "function" - ) { - this.nwcSettingsService.setActivePubkeyGetter(() => this.pubkey); - } - if ( - this.nwcSettingsService && - typeof this.nwcSettingsService.setPayments === "function" - ) { - this.nwcSettingsService.setPayments(this.payments); - } - if ( - this.feedEngine && - typeof this.feedEngine.run !== "function" && - typeof this.feedEngine.runFeed === "function" - ) { - this.feedEngine.run = (...args) => this.feedEngine.runFeed(...args); - } - this.registerRecentFeed(); - this.registerSubscriptionsFeed(); - this.registerWatchHistoryFeed(); - - this.watchHistoryController = new WatchHistoryController({ - watchHistoryService, - nostrClient, - showError: (message) => this.showError(message), - showSuccess: (message) => this.showSuccess(message), - dropWatchHistoryMetadata: (pointerKey) => - this.dropWatchHistoryMetadata(pointerKey), - getActivePubkey: () => - typeof this.pubkey === "string" && this.pubkey ? this.pubkey : "", - designSystem: this.designSystemContext, - }); - - this.watchHistoryTelemetry = new WatchHistoryTelemetry({ - watchHistoryService, - watchHistoryController: this.watchHistoryController, - nostrClient, - log: (message, ...args) => this.log(message, ...args), - normalizeHexPubkey: (value) => this.normalizeHexPubkey(value), - getActiveUserPubkey: () => this.pubkey, - ingestLocalViewEvent, - }); - - this.playbackService = - services.playbackService || - new PlaybackService({ - logger: devLogger, - torrentClient, - deriveTorrentPlaybackConfig, - isValidMagnetUri, - urlFirstEnabled: URL_FIRST_ENABLED, - analyticsCallbacks: { - "session-start": (detail) => { - const urlProvided = detail?.urlProvided ? "true" : "false"; - const magnetProvided = detail?.magnetProvided ? "true" : "false"; - const magnetUsable = detail?.magnetUsable ? "true" : "false"; - this.log( - `[playVideoWithFallback] Session start urlProvided=${urlProvided} magnetProvided=${magnetProvided} magnetUsable=${magnetUsable}` - ); - }, - fallback: (detail) => { - if (detail?.reason) { - this.log( - `[playVideoWithFallback] Falling back to WebTorrent (${detail.reason}).` - ); - } - }, - error: (detail) => { - if (detail?.error) { - this.log("[playVideoWithFallback] Playback error observed", detail.error); - } - }, - }, - }); - this.activePlaybackResultPromise = null; - this.activePlaybackSession = null; - - this.authService = - services.authService || - new AuthService({ - nostrClient, - userBlocks, - relayManager, - logger: devLogger, - accessControl, - authProviders, - getAuthProvider, - }); - this.authEventUnsubscribes.push( - this.authService.on("auth:login", (detail) => { - const maybePromise = this.handleAuthLogin(detail); - if (maybePromise && typeof maybePromise.then === "function") { - maybePromise.catch((error) => { - devLogger.error("Failed to process auth login event:", error); - }); - } - }) - ); - this.authEventUnsubscribes.push( - this.authService.on("auth:logout", (detail) => { - if (detail && typeof detail === "object") { - if (detail.__handled === true) { - return; - } - try { - detail.__handled = true; - } catch (error) { - devLogger.warn( - "Failed to mark auth logout detail as handled:", - error, - ); - } - } - - const maybePromise = this.handleAuthLogout(detail); - if (maybePromise && typeof maybePromise.then === "function") { - maybePromise.catch((error) => { - devLogger.error("Failed to process auth logout event:", error); - }); - } - }) - ); - this.authEventUnsubscribes.push( - this.authService.on("profile:updated", (detail) => { - try { - this.handleProfileUpdated(detail); - } catch (error) { - devLogger.warn( - "Failed to process profile update event:", - error, - ); - } - }) - ); - - this.commentThreadService = - services.commentThreadService || - new CommentThreadService({ - fetchVideoComments: (target, options) => - nostrClient?.fetchVideoComments?.(target, options), - subscribeVideoComments: (target, options) => - nostrClient?.subscribeVideoComments?.(target, options), - getProfileCacheEntry: (pubkey) => this.getProfileCacheEntry(pubkey), - batchFetchProfiles: (pubkeys) => this.batchFetchProfiles(pubkeys), - logger: { - warn: (...args) => devLogger.warn(...args), - }, - }); - this.boundCommentThreadReadyHandler = (snapshot) => - this.handleCommentThreadReady(snapshot); - this.boundCommentThreadAppendHandler = (payload) => - this.handleCommentThreadAppend(payload); - this.boundCommentThreadErrorHandler = (error) => - this.handleCommentThreadError(error); - if ( - this.commentThreadService && - typeof this.commentThreadService.setCallbacks === "function" - ) { - this.commentThreadService.setCallbacks({ - onThreadReady: this.boundCommentThreadReadyHandler, - onCommentsAppended: this.boundCommentThreadAppendHandler, - onError: this.boundCommentThreadErrorHandler, - }); - if (this.commentThreadService.defaultLimit) { - this.modalCommentLimit = this.commentThreadService.defaultLimit; - } - } - - // Profile and login modal controller state - this.profileController = null; - this.loginModalController = null; - this.currentUserNpub = null; - - this.initializeLoginModalController({ logIfMissing: true }); - - // Optional: a "profile" button or avatar (if used) - this.profileButton = document.getElementById("profileButton") || null; - this.profileAvatar = document.getElementById("profileAvatar") || null; - - const modalContainer = document.getElementById("modalContainer") || null; - - // Upload modal component - this.uploadButton = document.getElementById("uploadButton") || null; - const uploadModalSetup = initUploadModal({ + this.bootstrapper = new ApplicationBootstrap({ app: this, - uploadModalOverride: ui.uploadModal, - container: modalContainer, - services: { - authService: this.authService, - r2Service: this.r2Service, - }, - utilities: { - removeTrackingScripts, - setGlobalModalState, - }, - callbacks: { - publishVideoNote: (payload, options) => - this.publishVideoNote(payload, options), - showError: (message) => this.showError(message), - showSuccess: (message) => this.showSuccess(message), - getCurrentPubkey: () => this.pubkey, - safeEncodeNpub: (pubkey) => this.safeEncodeNpub(pubkey), - onSubmit: (event) => this.handleUploadSubmitEvent(event), - }, - }); - this.uploadModal = uploadModalSetup.modal; - this.uploadModalEvents = uploadModalSetup.events; - this.boundUploadSubmitHandler = uploadModalSetup.handlers.submit; - - const editModalSetup = initEditModal({ - app: this, - editModalOverride: ui.editModal, - container: modalContainer, - services: { - getMode: ({ video } = {}) => { - const candidate = - typeof video?.mode === "string" ? video.mode.trim().toLowerCase() : ""; - return candidate === "dev" ? "dev" : "live"; - }, - sanitizers: { - text: (value) => (typeof value === "string" ? value.trim() : ""), - url: (value) => (typeof value === "string" ? value.trim() : ""), - magnet: (value) => (typeof value === "string" ? value.trim() : ""), - checkbox: (value) => !!value, - }, - }, - utilities: { - removeTrackingScripts, - setGlobalModalState, - escapeHtml: (value) => escapeHtml(value), - }, - callbacks: { - showError: (message) => this.showError(message), - onSubmit: (event) => this.handleEditModalSubmit(event), - onCancel: () => this.showError(""), - }, - }); - - this.editModal = editModalSetup.modal; - this.editModalEvents = editModalSetup.events; - this.boundEditModalSubmitHandler = editModalSetup.handlers.submit; - this.boundEditModalCancelHandler = editModalSetup.handlers.cancel; - - this.revertModal = - (typeof ui.revertModal === "function" - ? ui.revertModal({ app: this }) - : ui.revertModal) || - new RevertModal({ - removeTrackingScripts, - setGlobalModalState, - formatAbsoluteTimestamp: (timestamp) => - this.formatAbsoluteTimestamp(timestamp), - formatTimeAgo: (timestamp) => this.formatTimeAgo(timestamp), - escapeHTML: (value) => this.escapeHTML(value), - truncateMiddle, - formatShortNpub: (value) => formatShortNpub(value), - fallbackThumbnailSrc: FALLBACK_THUMBNAIL_SRC, - container: modalContainer, - }); - - this.boundRevertConfirmHandler = (event) => { - this.handleRevertModalConfirm(event); - }; - this.revertModal.addEventListener( - "video:revert-confirm", - this.boundRevertConfirmHandler - ); - - const deleteModalSetup = initDeleteModal({ - app: this, - deleteModalOverride: ui.deleteModal, - container: modalContainer, - utilities: { - removeTrackingScripts, - setGlobalModalState, - truncateMiddle, - }, - callbacks: { - onConfirm: (event) => this.handleDeleteModalConfirm(event), - onCancel: () => this.showError(""), - }, - }); - - this.deleteModal = deleteModalSetup.modal; - this.deleteModalEvents = deleteModalSetup.events; - this.boundDeleteConfirmHandler = deleteModalSetup.handlers.confirm; - this.boundDeleteCancelHandler = deleteModalSetup.handlers.cancel; - - try { - const profileModalContainer = document.getElementById("modalContainer") || null; - if (profileModalContainer) { - const profileModalServices = { - normalizeHexPubkey: (value) => this.normalizeHexPubkey(value), - safeEncodeNpub: (pubkey) => this.safeEncodeNpub(pubkey), - safeDecodeNpub: (npub) => this.safeDecodeNpub(npub), - truncateMiddle: (value, maxLength) => truncateMiddle(value, maxLength), - formatShortNpub: (value) => formatShortNpub(value), - getProfileCacheEntry: (pubkey) => this.getProfileCacheEntry(pubkey), - batchFetchProfiles: (authorSet) => this.batchFetchProfiles(authorSet), - switchProfile: (pubkey) => this.authService.switchProfile(pubkey), - removeSavedProfile: (pubkey) => - this.authService.removeSavedProfile(pubkey), - relayManager, - userBlocks, - nostrClient, - nostrService: this.nostrService, - subscriptions, - accessControl, - moderation: moderationService, - getCurrentUserNpub: () => this.getCurrentUserNpub(), - nwcSettings: this.nwcSettingsService, - moderationSettings: { - getDefaultModerationSettings: () => getDefaultModerationSettings(), - getActiveModerationSettings: () => getModerationSettings(), - updateModerationSettings: (partial = {}) => - setModerationSettings(partial), - resetModerationSettings: () => resetModerationSettings(), - }, - loadVideos: (forceFetch, context) => - this.loadVideos(forceFetch, context), - onVideosShouldRefresh: (context) => - this.onVideosShouldRefresh(context), - describeAdminError: (code) => this.describeAdminError(code), - describeNotificationError: (code) => - this.describeNotificationError(code), - onAccessControlUpdated: () => this.onAccessControlUpdated(), - persistSavedProfiles: (options) => persistSavedProfiles(options), - watchHistoryService, - authService: this.authService, - requestAddProfileLogin: (options) => - this.requestProfileAdditionLogin(options), - describeLoginError: (error, fallbackMessage) => - this.describeLoginError(error, fallbackMessage), - hashtagPreferences: this.hashtagPreferences, - getHashtagPreferences: () => this.getHashtagPreferences(), - describeHashtagPreferencesError: (error, fallbackMessage) => - this.describeHashtagPreferencesError(error, { - fallbackMessage, - }), - log: (...args) => this.log(...args), - closeAllMoreMenus: (options) => this.closeAllMoreMenus(options), - clipboard: - typeof navigator !== "undefined" && navigator?.clipboard - ? navigator.clipboard - : null, - }; - - const profileModalState = { - getSavedProfiles: () => getSavedProfiles(), - setSavedProfiles: (profiles, options) => - setSavedProfiles(Array.isArray(profiles) ? profiles : [], options), - persistSavedProfiles: (options) => persistSavedProfiles(options), - getActivePubkey: () => getActiveProfilePubkey(), - setActivePubkey: (pubkey, options) => { - const normalized = - typeof pubkey === "string" && pubkey.trim() - ? pubkey.trim() - : null; - setStoredActiveProfilePubkey(normalized, options); - return getActiveProfilePubkey(); - }, - }; - - const profileModalCallbacks = { - onClose: () => this.handleProfileModalClosed(), - onLogout: async () => this.requestLogout(), - onChannelLink: (element) => this.handleProfileChannelLink(element), - onAddAccount: (payload) => this.handleAddProfile(payload), - onRequestLogoutProfile: (payload) => - this.handleProfileLogoutRequest(payload), - onRequestSwitchProfile: (payload) => - this.handleProfileSwitchRequest(payload), - onRelayOperation: (payload) => - this.handleProfileRelayOperation(payload), - onRelayModeToggle: (payload) => - this.handleProfileRelayModeToggle(payload), - onRelayRestore: (payload) => - this.handleProfileRelayRestore(payload), - onBlocklistMutation: (payload) => - this.handleProfileBlocklistMutation(payload), - onWalletPersist: (payload) => - this.handleProfileWalletPersist(payload), - onWalletTestRequest: (payload) => - this.handleProfileWalletTest(payload), - onWalletDisconnectRequest: (payload) => - this.handleProfileWalletDisconnect(payload), - onAdminMutation: (payload) => - this.handleProfileAdminMutation(payload), - onAdminNotifyError: (payload) => - this.handleProfileAdminNotifyError(payload), - onHistoryReady: (payload) => - this.handleProfileHistoryEvent(payload), - onModerationSettingsChange: (payload) => - this.handleModerationSettingsChange(payload), - }; - - this.profileController = new ProfileModalController({ - modalContainer: profileModalContainer, - removeTrackingScripts, - createWatchHistoryRenderer, - setGlobalModalState, - showError: (message) => this.showError(message), - showSuccess: (message) => this.showSuccess(message), - showStatus: (message) => this.showStatus(message), - constants: { - MAX_WALLET_DEFAULT_ZAP, - ADMIN_SUPER_NPUB, - ADMIN_DM_IMAGE_URL, - BITVID_WEBSITE_URL, - }, - services: profileModalServices, - state: profileModalState, - callbacks: profileModalCallbacks, - designSystem: this.designSystemContext, - }); - } else { - devLogger.warn( - "[Application] Profile modal controller disabled: modal container not found.", - ); - } - } catch (error) { - devLogger.error("Failed to initialize profile modal controller:", error); - } - - - // Optional small inline player stats - this.status = document.getElementById("status") || null; - this.progressBar = document.getElementById("progress") || null; - this.peers = document.getElementById("peers") || null; - this.speed = document.getElementById("speed") || null; - this.downloaded = document.getElementById("downloaded") || null; - - this.cleanupPromise = null; - this.zapController = null; - - this.videoModal = - (typeof ui.videoModal === "function" - ? ui.videoModal({ app: this }) - : ui.videoModal) || - new VideoModal({ - removeTrackingScripts, - setGlobalModalState, - document, - logger: { - log: (message, ...args) => this.log(message, ...args), - }, - mediaLoader: this.mediaLoader, - assets: { - fallbackThumbnailSrc: FALLBACK_THUMBNAIL_SRC, - }, - state: { - loadedThumbnails: this.loadedThumbnails, - }, - helpers: { - safeEncodeNpub: (pubkey) => this.safeEncodeNpub(pubkey), - formatShortNpub: (value) => formatShortNpub(value), - }, - }); - - if ( - this.videoModal && - typeof this.videoModal.setMediaLoader === "function" - ) { - this.videoModal.setMediaLoader(this.mediaLoader); - } - if ( - this.videoModal && - typeof this.videoModal.setTagPreferenceStateResolver === "function" - ) { - this.videoModal.setTagPreferenceStateResolver((tag) => - this.getTagPreferenceState(tag), - ); - } - this.zapController = new ZapController({ - videoModal: this.videoModal, - getCurrentVideo: () => this.currentVideo, - nwcSettings: this.nwcSettingsService, - isUserLoggedIn: () => this.isUserLoggedIn(), - hasSessionActor: () => - Boolean( - typeof nostrClient?.sessionActor?.pubkey === "string" && - nostrClient.sessionActor.pubkey.trim() - ), - notifyLoginRequired: () => - showLoginRequiredToZapNotification({ - app: this, - document: - this.statusContainer?.ownerDocument || - (typeof document !== "undefined" ? document : null), - }), - splitAndZap: (...args) => this.splitAndZap(...args), - payments: this.payments, - callbacks: { - onSuccess: (message) => this.showSuccess(message), - onError: (message) => this.showError(message), - }, - requestWalletPane: () => this.openWalletPane(), - }); - this.boundVideoModalCloseHandler = () => { - this.hideModal(); - }; - this.videoModal.addEventListener( - "modal:close", - this.boundVideoModalCloseHandler - ); - this.boundVideoModalCopyHandler = () => { - this.handleCopyMagnet(); - }; - this.videoModal.addEventListener( - "video:copy-magnet", - this.boundVideoModalCopyHandler - ); - this.boundVideoModalShareHandler = () => { - this.shareActiveVideo(); - }; - this.videoModal.addEventListener( - "video:share", - this.boundVideoModalShareHandler - ); - this.boundVideoModalModerationOverrideHandler = (event) => { - const detail = event?.detail || {}; - const targetVideo = - detail && typeof detail.video === "object" - ? detail.video - : this.currentVideo || null; - if (!targetVideo) { - const trigger = detail?.trigger; - if (trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - return; - } - - const handled = this.handleModerationOverride({ - video: targetVideo, - card: detail?.card || null, - }); - - if (handled === false) { - const trigger = detail?.trigger; - if (trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - } - }; - this.videoModal.addEventListener( - "video:moderation-override", - this.boundVideoModalModerationOverrideHandler, - ); - this.boundVideoModalModerationBlockHandler = (event) => { - const detail = event?.detail || {}; - const targetVideo = - detail && typeof detail.video === "object" - ? detail.video - : this.currentVideo || null; - const trigger = detail?.trigger || null; - - if (!targetVideo) { - if (trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - return; - } - - Promise.resolve( - this.handleModerationBlock({ - video: targetVideo, - card: detail?.card || null, - }), - ) - .then((handled) => { - if (handled === false && trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - }) - .catch((error) => { - devLogger.warn( - "[Application] Failed to handle modal moderation block:", - error, - ); - if (trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - }); - }; - this.videoModal.addEventListener( - "video:moderation-block", - this.boundVideoModalModerationBlockHandler, - ); - this.boundVideoModalModerationHideHandler = (event) => { - const detail = event?.detail || {}; - const targetVideo = - detail && typeof detail.video === "object" - ? detail.video - : this.currentVideo || null; - const trigger = detail?.trigger || null; - - if (!targetVideo) { - if (trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - return; - } - - Promise.resolve( - this.handleModerationHide({ - video: targetVideo, - card: detail?.card || null, - }), - ) - .then((handled) => { - if (handled === false && trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - }) - .catch((error) => { - devLogger.warn( - "[Application] Failed to handle modal moderation hide:", - error, - ); - if (trigger) { - trigger.disabled = false; - trigger.removeAttribute("aria-busy"); - } - }); - }; - this.videoModal.addEventListener( - "video:moderation-hide", - this.boundVideoModalModerationHideHandler, - ); - this.boundVideoModalTagActivateHandler = (event) => { - const detail = event?.detail || {}; - const nativeEvent = detail?.nativeEvent || null; - if (nativeEvent) { - nativeEvent.preventDefault?.(); - nativeEvent.stopPropagation?.(); - } - - this.handleTagPreferenceActivation({ - tag: detail?.tag, - trigger: detail?.trigger || null, - context: "modal", - video: detail?.video || this.currentVideo || null, - event: nativeEvent, - }); - }; - this.videoModal.addEventListener( - "tag:activate", - this.boundVideoModalTagActivateHandler, - ); - this.boundVideoModalSimilarSelectHandler = (event) => { - const detail = event?.detail || {}; - const selectedVideo = - detail && typeof detail.video === "object" ? detail.video : null; - const triggerCandidate = - detail?.event?.currentTarget || - (detail?.card && typeof detail.card.getRoot === "function" - ? detail.card.getRoot() - : null); - - this.setLastModalTrigger(triggerCandidate || null); - - if (detail?.event) { - detail.event.preventDefault?.(); - detail.event.stopPropagation?.(); - } - - if (!selectedVideo) { - return; - } - - const playbackOptions = { - trigger: this.lastModalTrigger, - }; - - if (typeof selectedVideo.url === "string" && selectedVideo.url) { - playbackOptions.url = selectedVideo.url; - } - if (typeof selectedVideo.magnet === "string" && selectedVideo.magnet) { - playbackOptions.magnet = selectedVideo.magnet; - } - - if (typeof selectedVideo.id === "string" && selectedVideo.id) { - Promise.resolve( - this.playVideoByEventId(selectedVideo.id, playbackOptions) - ).catch((error) => { - devLogger.error( - "[Application] Failed to play selected similar video:", - error - ); - }); - return; - } - - Promise.resolve(this.playVideoWithFallback(playbackOptions)).catch( - (error) => { - devLogger.error( - "[Application] Failed to start playback for similar video:", - error - ); - } - ); - }; - this.videoModal.addEventListener( - "similar:select", - this.boundVideoModalSimilarSelectHandler - ); - this.boundVideoModalReactionHandler = (event) => { - const detail = event?.detail || {}; - this.handleVideoReaction(detail); - }; - this.videoModal.addEventListener( - "video:reaction", - this.boundVideoModalReactionHandler - ); - this.boundVideoModalContextActionHandler = (event) => { - const detail = event?.detail || {}; - const action = typeof detail.action === "string" ? detail.action : ""; - if (!action) { - return; - } - const dataset = { - ...(detail.dataset || {}), - }; - if (!dataset.context) { - dataset.context = "modal"; - } - this.handleMoreMenuAction(action, dataset); - }; - this.videoModal.addEventListener( - "video:context-action", - this.boundVideoModalContextActionHandler - ); - this.boundVideoModalCreatorHandler = () => { - this.openCreatorChannel(); - }; - this.videoModal.addEventListener( - "creator:navigate", - this.boundVideoModalCreatorHandler - ); - this.boundVideoModalZapHandler = (event) => { - this.zapController?.sendZap(event?.detail || {}); - }; - this.boundVideoModalZapOpenHandler = (event) => { - const requiresLogin = Boolean(event?.detail?.requiresLogin); - this.pendingModalZapOpen = requiresLogin; - - const openResult = this.zapController?.open({ requiresLogin }); - if (!openResult) { - event?.preventDefault?.(); - if (!requiresLogin) { - this.pendingModalZapOpen = false; - } - this.videoModal?.closeZapDialog?.({ - silent: true, - restoreFocus: false, - }); - return; - } - - this.pendingModalZapOpen = false; - }; - this.boundVideoModalZapCloseHandler = () => { - this.zapController?.close(); - }; - this.boundVideoModalZapAmountHandler = (event) => { - this.zapController?.setAmount(event?.detail?.amount); - }; - this.boundVideoModalZapCommentHandler = (event) => { - this.zapController?.setComment(event?.detail?.comment); - }; - this.videoModal.addEventListener( - "video:zap", - this.boundVideoModalZapHandler - ); - this.videoModal.addEventListener( - "zap:open", - this.boundVideoModalZapOpenHandler - ); - this.videoModal.addEventListener( - "zap:close", - this.boundVideoModalZapCloseHandler - ); - this.videoModal.addEventListener( - "zap:amount-change", - this.boundVideoModalZapAmountHandler - ); - this.videoModal.addEventListener( - "zap:comment-change", - this.boundVideoModalZapCommentHandler - ); - this.boundVideoModalZapWalletHandler = () => { - this.zapController?.handleWalletLink(); - }; - this.videoModal.addEventListener( - "zap:wallet-link", - this.boundVideoModalZapWalletHandler - ); - this.boundVideoModalCommentSubmitHandler = (event) => { - this.handleVideoModalCommentSubmit(event?.detail || {}); - }; - this.videoModal.addEventListener( - "comment:submit", - this.boundVideoModalCommentSubmitHandler - ); - this.boundVideoModalCommentRetryHandler = (event) => { - this.handleVideoModalCommentRetry(event?.detail || {}); - }; - this.videoModal.addEventListener( - "comment:retry", - this.boundVideoModalCommentRetryHandler - ); - this.boundVideoModalCommentLoadMoreHandler = (event) => { - this.handleVideoModalCommentLoadMore(event?.detail || {}); - }; - this.videoModal.addEventListener( - "comment:load-more", - this.boundVideoModalCommentLoadMoreHandler - ); - this.boundVideoModalCommentLoginHandler = (event) => { - this.handleVideoModalCommentLoginRequired(event?.detail || {}); - }; - this.videoModal.addEventListener( - "comment:login-required", - this.boundVideoModalCommentLoginHandler - ); - this.boundVideoModalCommentMuteHandler = (event) => { - this.handleVideoModalCommentMute(event?.detail || {}); - }; - this.videoModal.addEventListener( - "comment:mute-author", - this.boundVideoModalCommentMuteHandler - ); - - this.moreMenuController = new MoreMenuController({ - document, - accessControl, - userBlocks, - subscriptions, - clipboard: - typeof navigator !== "undefined" && navigator?.clipboard - ? navigator.clipboard - : null, - isDevMode, - designSystem: this.designSystemContext, - callbacks: { - getCurrentVideo: () => this.currentVideo, - getCurrentUserNpub: () => this.getCurrentUserNpub(), - getCurrentUserPubkey: () => this.pubkey, - canCurrentUserManageBlacklist: () => - this.canCurrentUserManageBlacklist(), - openCreatorChannel: () => this.openCreatorChannel(), - goToProfile: (author) => this.goToProfile(author), - showError: (message) => this.showError(message), - showSuccess: (message) => this.showSuccess(message), - safeEncodeNpub: (pubkey) => this.safeEncodeNpub(pubkey), - safeDecodeNpub: (npub) => this.safeDecodeNpub(npub), - buildShareUrlFromEventId: (eventId) => - this.buildShareUrlFromEventId(eventId), - handleRemoveHistoryAction: (payload) => - this.handleRemoveHistoryAction(payload), - handleRepostAction: (payload) => this.handleRepostAction(payload), - handleMirrorAction: (payload) => this.handleMirrorAction(payload), - handleEnsurePresenceAction: (payload) => - this.handleEnsurePresenceAction(payload), - loadVideos: () => this.loadVideos(), - refreshAllVideoGrids: (options) => this.refreshAllVideoGrids(options), - onUserBlocksUpdated: () => { - if (this.profileController) { - try { - this.profileController.populateBlockedList(); - } catch (error) { - devLogger.warn( - "[profileModal] Failed to refresh blocked list after update:", - error, - ); - } - } - }, - }, - }); - this.moreMenuController.setVideoModal(this.videoModal); - this.videoSettingsPopovers = new Map(); - this.tagPreferencePopovers = new Map(); - - // Hide/Show Subscriptions Link - this.subscriptionsLink = null; - - // Notification containers - this.notificationPortal = - document.getElementById("notificationPortal") || null; - this.errorContainer = document.getElementById("errorContainer") || null; - this.successContainer = document.getElementById("successContainer") || null; - this.statusContainer = document.getElementById("statusContainer") || null; - this.statusMessage = - this.statusContainer?.querySelector("[data-status-message]") || null; - this.statusAutoHideHandle = null; - this.lastExperimentalWarningKey = null; - this.lastExperimentalWarningAt = 0; - - // Auth state - this.pubkey = null; - this.currentMagnetUri = null; - this.currentVideo = null; - this.currentVideoPointer = null; - this.currentVideoPointerKey = null; - this.videoSubscription = this.nostrService.getVideoSubscription() || null; - this.videoList = null; - this.videoListPopularTags = null; - this.modalViewCountUnsub = null; - this.modalReactionUnsub = null; - this.modalReactionPointerKey = null; - this.modalReactionState = { - counts: { "+": 0, "-": 0 }, - total: 0, - userReaction: "", - }; - - // Videos stored as a Map (key=event.id) - this.videosMap = this.nostrService.getVideosMap(); - this.unsubscribeFromNostrService = this.nostrService.on( - "subscription:changed", - ({ subscription }) => { - this.videoSubscription = subscription || null; - } - ); - this.boundNwcSettingsToastHandler = null; - Object.defineProperty(this, "savedProfiles", { - configurable: false, - enumerable: false, - get() { - return getSavedProfiles(); - }, - set(next) { - setSavedProfiles(Array.isArray(next) ? next : [], { - persist: false, - persistActive: false, - }); - }, - }); - - Object.defineProperty(this, "activeProfilePubkey", { - configurable: false, - enumerable: false, - get() { - return getActiveProfilePubkey(); - }, - set(value) { - setStoredActiveProfilePubkey(value, { persist: false }); - }, - }); - - Object.defineProperty(this, "profileCache", { - configurable: false, - enumerable: false, - get() { - return getProfileCacheMap(); - }, - }); - - if (typeof window !== "undefined" && typeof window.addEventListener === "function") { - this.boundNwcSettingsToastHandler = (event) => { - const detail = event?.detail || {}; - if (detail.source !== "nwc-settings") { - return; - } - const rawMessage = - typeof detail.message === "string" ? detail.message.trim() : ""; - const message = rawMessage || "Wallet settings storage issue detected."; - this.log(`[nwcSettings] ${message}`); - if (detail.variant === "warning") { - this.showStatus(message); - if (typeof window !== "undefined" && typeof window.setTimeout === "function") { - window.setTimeout(() => { - this.showStatus(""); - }, 5000); - } - } else { - this.showError(message); - } - }; - window.addEventListener("bitvid:toast", this.boundNwcSettingsToastHandler); - } - - const videoListViewConfig = { - document, - mediaLoader: this.mediaLoader, - badgeHelpers: { - attachHealthBadges: this.attachHealthBadgesWithCache, - attachUrlHealthBadges: (container, onCheck) => - attachUrlHealthBadges(container, onCheck), - }, - formatters: { - formatTimeAgo: (timestamp) => this.formatTimeAgo(timestamp), - formatViewCountLabel: (total) => this.formatViewCountLabel(total), - }, - helpers: { - escapeHtml: (value) => this.escapeHTML(value), - isMagnetSupported: (magnet) => isValidMagnetUri(magnet), - toLocaleString: (value) => - typeof value === "number" ? value.toLocaleString() : value, - }, + services: bootstrapServices, + ui, + helpers, + documentRef: typeof document !== "undefined" ? document : null, + windowRef: typeof window !== "undefined" ? window : null, assets: { fallbackThumbnailSrc: FALLBACK_THUMBNAIL_SRC, unsupportedBtihMessage: UNSUPPORTED_BTITH_MESSAGE, }, - state: { - loadedThumbnails: this.loadedThumbnails, - videosMap: this.videosMap, - urlHealthByVideoId: this.urlHealthSnapshots, - streamHealthByVideoId: this.streamHealthSnapshots, - }, - utils: { - dedupeVideos: (videos) => this.dedupeVideosByRoot(videos), - getAllEvents: () => Array.from(nostrClient.allEvents.values()), - hasOlderVersion: (video, events) => this.hasOlderVersion(video, events), - derivePointerInfo: (video) => this.deriveVideoPointerInfo(video), - persistWatchHistoryMetadata: (video, pointerInfo) => - this.persistWatchHistoryMetadataForVideo(video, pointerInfo), - getShareUrlBase: () => this.getShareUrlBase(), - buildShareUrlFromNevent: (nevent) => this.buildShareUrlFromNevent(nevent), - buildShareUrlFromEventId: (eventId) => this.buildShareUrlFromEventId(eventId), - getKnownVideoPostedAt: (video) => this.getKnownVideoPostedAt(video), - resolveVideoPostedAt: (video) => this.resolveVideoPostedAt(video), - canManageBlacklist: () => this.canCurrentUserManageBlacklist(), - canEditVideo: (video) => video?.pubkey === this.pubkey, - canDeleteVideo: (video) => video?.pubkey === this.pubkey, - batchFetchProfiles: (authorSet) => this.batchFetchProfiles(authorSet), - bindThumbnailFallbacks: (container) => this.bindThumbnailFallbacks(container), - handleUrlHealthBadge: (payload) => this.handleUrlHealthBadge(payload), - refreshDiscussionCounts: (videos, { container } = {}) => - this.refreshVideoDiscussionCounts(videos, { - videoListRoot: container || this.videoList || null, - }), - ensureGlobalMoreMenuHandlers: () => this.ensureGlobalMoreMenuHandlers(), - requestMoreMenu: (detail = {}) => this.requestMoreMenu(detail), - closeMoreMenu: (detail = {}) => this.closeMoreMenu(detail), - requestSettingsMenu: (detail = {}) => - this.requestVideoSettingsMenu(detail), - closeSettingsMenu: (detail = {}) => - this.closeVideoSettingsMenu(detail), - closeAllMenus: (options) => this.closeAllMoreMenus(options), - }, - renderers: { - getLoadingMarkup: (message) => getSidebarLoadingMarkup(message), - }, - allowNsfw: ALLOW_NSFW_CONTENT === true, - designSystem: this.designSystemContext, - }; - this.videoListView = - (typeof ui.videoListView === "function" - ? ui.videoListView({ app: this, config: videoListViewConfig }) - : ui.videoListView) || - new VideoListView(videoListViewConfig); - - if ( - this.videoListView && - typeof this.videoListView.setTagPreferenceStateResolver === "function" - ) { - this.videoListView.setTagPreferenceStateResolver((tag) => - this.getTagPreferenceState(tag), - ); - } - - if ( - this.videoListView && - typeof this.videoListView.setTagActivationHandler === "function" - ) { - this.videoListView.setTagActivationHandler((detail = {}) => - this.handleTagPreferenceActivation(detail), - ); - } - - this.videoListViewPlaybackHandler = ({ - videoId, - url, - magnet, - trigger, - }) => { - if (videoId) { - Promise.resolve( - this.playVideoByEventId(videoId, { url, magnet, trigger }) - ).catch((error) => { - devLogger.error("[VideoListView] Failed to play by event id:", error); - }); - return; - } - Promise.resolve( - this.playVideoWithFallback({ url, magnet, trigger }) - ).catch( - (error) => { - devLogger.error("[VideoListView] Failed to start playback:", error); - } - ); - }; - this.videoListView.setPlaybackHandler(this.videoListViewPlaybackHandler); - - this.videoListViewEditHandler = ({ video, index, trigger }) => { - if (!video?.id) { - return; - } - this.handleEditVideo({ - eventId: video.id, - index: Number.isFinite(index) ? index : null, - triggerElement: trigger, - video, - }); - }; - this.videoListView.setEditHandler(this.videoListViewEditHandler); - - this.videoListViewRevertHandler = ({ video, index, trigger }) => { - if (!video?.id) { - return; - } - this.handleRevertVideo({ - eventId: video.id, - index: Number.isFinite(index) ? index : null, - triggerElement: trigger, - video, - }); - }; - this.videoListView.setRevertHandler(this.videoListViewRevertHandler); - - this.videoListViewDeleteHandler = ({ video, index }) => { - if (!video?.id) { - return; - } - this.handleFullDeleteVideo({ - eventId: video.id, - index: Number.isFinite(index) ? index : null, - video, - }); - }; - this.videoListView.setDeleteHandler(this.videoListViewDeleteHandler); - - this.videoListView.setModerationOverrideHandler((detail = {}) => - this.handleModerationOverride(detail) - ); - this.videoListView.setModerationBlockHandler((detail = {}) => - this.handleModerationBlock(detail) - ); - this.videoListView.setModerationHideHandler((detail = {}) => - this.handleModerationHide(detail) - ); - - if (this.moreMenuController) { - this.moreMenuController.attachVideoListView(this.videoListView); - } - - // NEW: reference to the login modal's close button - this.closeLoginModalBtn = - document.getElementById("closeLoginModal") || null; - - this.appChromeController = new AppChromeController({ - elements: { - logoutButton: this.logoutButton, - profileButton: this.profileButton, - uploadButton: this.uploadButton, - loginButton: this.loginButton, - closeLoginModalButton: this.closeLoginModalBtn, - }, - callbacks: { - requestLogout: () => this.requestLogout(), - showError: (message) => this.showError(message), - showProfileModal: () => - this.profileController && - typeof this.profileController.show === "function" - ? this.profileController.show() - : null, - openUploadModal: ({ triggerElement }) => { - if (this.uploadModal) { - this.uploadModal.open({ triggerElement }); - } - }, - onLoginModalOpened: () => setGlobalModalState("login", true), - onLoginModalClosed: () => setGlobalModalState("login", false), - flushWatchHistory: (reason, context) => - this.flushWatchHistory(reason, context), - cleanup: () => this.cleanup(), - hideModal: () => this.hideModal(), - }, - utilities: { - prepareLoginModal: () => - prepareStaticModal({ id: "loginModal" }) || - document.getElementById("loginModal"), - prepareApplicationModal: () => - prepareStaticModal({ id: "nostrFormModal" }) || - document.getElementById("nostrFormModal"), - openModal: (modal, options) => openStaticModal(modal, options), - closeModal: (modalId) => closeStaticModal(modalId), - }, - environment: { - document: typeof document !== "undefined" ? document : null, - window: typeof window !== "undefined" ? window : null, - }, - logger: devLogger, }); - // Build a set of blacklisted event IDs (hex) from nevent strings, skipping empties - this.blacklistedEventIds = new Set(); - for (const neventStr of ADMIN_INITIAL_EVENT_BLACKLIST) { - // Skip any empty or obviously invalid strings - if (!neventStr || neventStr.trim().length < 8) { - continue; - } - try { - const decoded = window.NostrTools.nip19.decode(neventStr); - if (decoded.type === "nevent" && decoded.data.id) { - this.blacklistedEventIds.add(decoded.data.id); - } - } catch (err) { - devLogger.error( - "[Application] Invalid nevent in blacklist:", - neventStr, - err - ); - } - } + const { modalManager } = this.bootstrapper.initialize(); + this.modalManager = modalManager; + + this.modalCreatorProfileRequestToken = null; + + this.commentController = null; + this.initializeCommentController(); this.unsubscribeFromPubkeyState = subscribeToAppStateKey( "pubkey", @@ -1608,6 +238,8 @@ class Application { } } ); + + this.initializeModerationActionController(); } get modalVideo() { @@ -2208,11 +840,12 @@ class Application { if (!video || typeof video !== "object") { return video; } + let decoratedVideo = video; if (typeof this.decorateVideoModeration === "function") { try { const decorated = this.decorateVideoModeration(video); if (decorated && typeof decorated === "object") { - return decorated; + decoratedVideo = decorated; } } catch (error) { devLogger.warn( @@ -2221,7 +854,22 @@ class Application { ); } } - return video; + if (typeof this.decorateVideoCreatorIdentity === "function") { + try { + const identityDecorated = this.decorateVideoCreatorIdentity( + decoratedVideo, + ); + if (identityDecorated && typeof identityDecorated === "object") { + decoratedVideo = identityDecorated; + } + } catch (error) { + devLogger.warn( + "[Application] Failed to decorate similar content identity", + error, + ); + } + } + return decoratedVideo; }; const target = activeVideo && typeof activeVideo === "object" ? decorateCandidate(activeVideo) : null; @@ -2605,317 +1253,44 @@ class Application { } } - resetModalCommentState({ hide = true } = {}) { - if (!this.videoModal) { + initializeCommentController() { + if (!this.commentThreadService || !this.videoModal) { return; } - this.videoModal.clearComments?.(); - this.videoModal.resetCommentComposer?.(); - this.videoModal.setCommentComposerState?.({ - disabled: true, - reason: "disabled", - }); - if (hide) { - this.videoModal.setCommentsVisibility?.(false); - } - this.videoModal.setCommentStatus?.(""); - } - - teardownModalCommentSubscription({ resetUi = true } = {}) { - if (this.commentThreadService) { - try { - this.commentThreadService.teardown(); - } catch (error) { - devLogger.warn("[comment] Failed to teardown modal comment thread:", error); - } - } - this.modalCommentLoadPromise = null; - this.modalCommentPublishPromise = null; - this.modalCommentState = { - videoEventId: null, - videoDefinitionAddress: null, - parentCommentId: null, - }; - this.modalCommentProfiles = new Map(); - if (resetUi) { - this.resetModalCommentState(); - } - this.videoModal?.setCommentSectionCallbacks?.({ teardown: null }); - } - - subscribeModalComments(video) { - if (!this.videoModal) { + if (this.commentController) { return; } - if (!video) { - this.teardownModalCommentSubscription(); - return; - } - - this.videoModal.setCommentSectionCallbacks?.({ - teardown: () => this.teardownModalCommentSubscription(), - }); - - if (!this.commentThreadService) { - this.resetModalCommentState(); - return; - } - - this.teardownModalCommentSubscription({ resetUi: false }); - - this.videoModal.hideCommentsDisabledMessage?.(); - - if (video.enableComments === false) { - this.resetModalCommentState(); - this.videoModal.showCommentsDisabledMessage?.( - "Comments have been turned off for this video." - ); - return; - } - - const videoEventId = - typeof video.id === "string" && video.id.trim() ? video.id.trim() : ""; - const videoDefinitionAddress = buildVideoAddressPointer(video); - - if (!videoEventId || !videoDefinitionAddress) { - this.resetModalCommentState({ hide: false }); - this.videoModal.setCommentStatus?.( - "Comments are unavailable for this video.", - ); - return; - } - - this.modalCommentState = { - videoEventId, - videoDefinitionAddress, - parentCommentId: null, - }; - this.modalCommentProfiles = new Map(); - if (this.commentThreadService.defaultLimit) { - this.modalCommentLimit = this.commentThreadService.defaultLimit; - } - - this.videoModal.setCommentsVisibility?.(true); - this.videoModal.clearComments?.(); - this.videoModal.resetCommentComposer?.(); - this.videoModal.setCommentStatus?.("Loading comments…"); - this.applyCommentComposerAuthState(); - - const loadPromise = this.commentThreadService.loadThread({ - video, - parentCommentId: null, - limit: this.modalCommentLimit, - }); - - if (!loadPromise || typeof loadPromise.then !== "function") { - this.applyCommentComposerAuthState(); - return; - } - - this.modalCommentLoadPromise = loadPromise; - loadPromise - .then(() => { - if (this.modalCommentLoadPromise === loadPromise) { - this.modalCommentLoadPromise = null; - } - this.applyCommentComposerAuthState(); - }) - .catch((error) => { - if (this.modalCommentLoadPromise === loadPromise) { - this.modalCommentLoadPromise = null; - } - this.handleCommentThreadError(error); - }); - } - - applyCommentComposerAuthState() { - if (!this.videoModal) { - return; - } - - if (!this.modalCommentState.videoEventId) { - return; - } - - if (this.currentVideo?.enableComments === false) { - this.videoModal.showCommentsDisabledMessage?.( - "Comments have been turned off for this video." - ); - this.videoModal.setCommentComposerState?.({ - disabled: true, - reason: "disabled", - }); - return; - } - - this.videoModal.hideCommentsDisabledMessage?.(); - - if (!this.isUserLoggedIn()) { - this.videoModal.setCommentComposerState?.({ - disabled: true, - reason: "login-required", - }); - return; - } - - this.videoModal.setCommentComposerState?.({ - disabled: false, - reason: "", - }); - this.videoModal.setCommentStatus?.(""); - } - - handleCommentThreadReady(snapshot) { - if (!snapshot || !this.videoModal) { - return; - } - - if (snapshot.videoEventId !== this.modalCommentState.videoEventId) { - return; - } - - this.modalCommentProfiles = this.createMapFromInput(snapshot.profiles); - this.modalCommentState.parentCommentId = - typeof snapshot.parentCommentId === "string" && - snapshot.parentCommentId.trim() - ? snapshot.parentCommentId.trim() - : null; - - const sanitizedSnapshot = this.buildModalCommentSnapshot(snapshot); - this.videoModal.renderComments?.(sanitizedSnapshot); - this.videoModal.setCommentStatus?.(""); - this.applyCommentComposerAuthState(); - } - - handleCommentThreadAppend(payload) { - if (!payload || !this.videoModal) { - return; - } - - if (payload.videoEventId !== this.modalCommentState.videoEventId) { - return; - } - - const comments = this.createMapFromInput(payload.commentsById); - const profiles = this.createMapFromInput(payload.profiles); - profiles.forEach((profile, pubkey) => { - this.modalCommentProfiles.set(pubkey, profile); - }); - - const commentIds = Array.isArray(payload.commentIds) - ? payload.commentIds - : []; - - commentIds.forEach((commentId) => { - if (!comments.has(commentId)) { - return; - } - const event = comments.get(commentId); - if (!event || this.shouldHideModalComment(event)) { - return; - } - const enriched = this.enrichCommentEvent(event); - this.videoModal.appendComment?.(enriched); + this.commentController = new VideoModalCommentController({ + commentThreadService: this.commentThreadService, + videoModal: this.videoModal, + auth: { + isLoggedIn: () => this.isUserLoggedIn(), + initializeLoginModalController: (options) => + this.initializeLoginModalController(options), + getLoginModalController: () => this.loginModalController, + requestLogin: (options) => + this.authService?.requestLogin?.(options) ?? Promise.resolve(false), + }, + callbacks: { + showError: (message) => this.showError(message), + showStatus: (message, options) => this.showStatus(message, options), + muteAuthor: (pubkey) => userBlocks.addBlock(pubkey, this.pubkey), + shouldHideAuthor: (pubkey) => this.shouldHideCommentAuthor(pubkey), + }, + services: { + publishComment: (target, eventData) => + nostrClient.publishVideoComment(target, eventData), + }, + utils: { + normalizeHexPubkey: (value) => this.normalizeHexPubkey(value), + }, }); } - handleCommentThreadError(error) { - if (error) { - devLogger.warn("[comment]", error); - } - if (!this.videoModal) { - return; - } - this.videoModal.setCommentStatus?.( - "Failed to load comments. Please try again later.", - ); - if (!this.isUserLoggedIn()) { - this.videoModal.setCommentComposerState?.({ - disabled: true, - reason: "login-required", - }); - } - } - - createMapFromInput(input) { - if (input instanceof Map) { - return new Map(input); - } - const map = new Map(); - if (Array.isArray(input)) { - input.forEach((entry) => { - if (Array.isArray(entry) && entry.length >= 2) { - map.set(entry[0], entry[1]); - } - }); - return map; - } - if (input && typeof input === "object") { - Object.entries(input).forEach(([key, value]) => { - map.set(key, value); - }); - } - return map; - } - - createChildrenMapFromInput(input) { - const source = input instanceof Map ? input : this.createMapFromInput(input); - const result = new Map(); - source.forEach((value, key) => { - const list = Array.isArray(value) ? value.filter(Boolean) : []; - result.set(key, list); - }); - return result; - } - - enrichCommentEvent(event) { - const cloned = { ...(event || {}) }; - const normalized = this.normalizeHexPubkey(cloned.pubkey); - if (normalized && this.modalCommentProfiles.has(normalized)) { - cloned.profile = this.modalCommentProfiles.get(normalized); - } - return cloned; - } - - buildModalCommentSnapshot(snapshot) { - const comments = this.createMapFromInput(snapshot?.commentsById); - const children = this.createChildrenMapFromInput(snapshot?.childrenByParent); - const sanitizedComments = new Map(); - - comments.forEach((event, key) => { - if (!event || this.shouldHideModalComment(event)) { - return; - } - sanitizedComments.set(key, this.enrichCommentEvent(event)); - }); - - const sanitizedChildren = new Map(); - children.forEach((ids, parentId) => { - const seen = new Set(); - const filtered = []; - ids.forEach((id) => { - if (!sanitizedComments.has(id) || seen.has(id)) { - return; - } - seen.add(id); - filtered.push(id); - }); - sanitizedChildren.set(parentId, filtered); - }); - - return { - videoEventId: snapshot.videoEventId, - parentCommentId: snapshot.parentCommentId || null, - commentsById: sanitizedComments, - childrenByParent: sanitizedChildren, - profiles: this.modalCommentProfiles, - }; - } - - shouldHideModalComment(event) { - const normalized = this.normalizeHexPubkey(event?.pubkey); + shouldHideCommentAuthor(pubkey) { + const normalized = this.normalizeHexPubkey(pubkey); if (!normalized) { return false; } @@ -2943,195 +1318,6 @@ class Application { return false; } - async handleVideoModalCommentSubmit(detail = {}) { - if (this.modalCommentPublishPromise) { - return; - } - - const text = - typeof detail.text === "string" && detail.text.trim() - ? detail.text.trim() - : ""; - if (!text) { - return; - } - - if (!this.isUserLoggedIn()) { - this.videoModal.setCommentComposerState?.({ - disabled: true, - reason: "login-required", - }); - this.handleVideoModalCommentLoginRequired(detail); - return; - } - - const video = this.currentVideo; - if (!video || video.enableComments === false) { - return; - } - - const videoEventId = - typeof video.id === "string" && video.id.trim() ? video.id.trim() : ""; - const videoDefinitionAddress = buildVideoAddressPointer(video); - - if (!videoEventId || !videoDefinitionAddress) { - this.showError("Comments are unavailable for this video."); - return; - } - - const parentCommentId = - typeof detail.parentId === "string" && detail.parentId.trim() - ? detail.parentId.trim() - : null; - - this.videoModal.setCommentComposerState?.({ - disabled: true, - reason: "submitting", - }); - - const publishPromise = Promise.resolve( - nostrClient.publishVideoComment( - { - videoEventId, - videoDefinitionAddress, - parentCommentId, - }, - { - content: text, - }, - ), - ); - - this.modalCommentPublishPromise = publishPromise; - - try { - const result = await publishPromise; - if (!result?.ok || !result.event) { - throw result?.error || new Error("publish-failed"); - } - - const event = this.enrichCommentEvent(result.event); - if (this.commentThreadService) { - try { - this.commentThreadService.processIncomingEvent(event); - } catch (error) { - devLogger.warn( - "[comment] Failed to process optimistic comment event:", - error, - ); - this.videoModal.appendComment?.(event); - } - } else { - this.videoModal.appendComment?.(event); - } - - this.videoModal.resetCommentComposer?.(); - this.applyCommentComposerAuthState(); - this.videoModal.setCommentStatus?.("Comment posted."); - } catch (error) { - devLogger.warn("[comment] Failed to publish comment:", error); - this.videoModal.setCommentComposerState?.({ - disabled: false, - reason: "error", - }); - this.showError("Failed to post comment. Please try again."); - } finally { - if (this.modalCommentPublishPromise === publishPromise) { - this.modalCommentPublishPromise = null; - } - } - } - - handleVideoModalCommentRetry(detail = {}) { - this.handleVideoModalCommentSubmit(detail); - } - - handleVideoModalCommentLoadMore() { - if (!this.commentThreadService || !this.currentVideo) { - return; - } - - if (this.modalCommentLoadPromise) { - return; - } - - const increment = this.commentThreadService.defaultLimit || 40; - this.modalCommentLimit = (this.modalCommentLimit || increment) + increment; - - const loadPromise = this.commentThreadService.loadThread({ - video: this.currentVideo, - parentCommentId: this.modalCommentState.parentCommentId, - limit: this.modalCommentLimit, - }); - - if (!loadPromise || typeof loadPromise.then !== "function") { - return; - } - - this.modalCommentLoadPromise = loadPromise; - loadPromise - .then(() => { - if (this.modalCommentLoadPromise === loadPromise) { - this.modalCommentLoadPromise = null; - } - this.applyCommentComposerAuthState(); - }) - .catch((error) => { - if (this.modalCommentLoadPromise === loadPromise) { - this.modalCommentLoadPromise = null; - } - devLogger.warn("[comment] Failed to load more comments:", error); - this.showError("Failed to load more comments. Please try again."); - }); - } - - handleVideoModalCommentLoginRequired(detail = {}) { - this.applyCommentComposerAuthState(); - this.initializeLoginModalController({ logIfMissing: true }); - const triggerElement = detail?.triggerElement || null; - try { - const opened = this.loginModalController?.openModal?.({ triggerElement }); - if (opened) { - return; - } - } catch (error) { - devLogger.warn("[comment] Failed to open login modal:", error); - } - - this.authService - .requestLogin({ allowAccountSelection: true }) - .catch((error) => { - devLogger.warn("[comment] Login request failed:", error); - }); - } - - async handleVideoModalCommentMute(detail = {}) { - const pubkey = - typeof detail?.pubkey === "string" && detail.pubkey.trim() - ? detail.pubkey.trim() - : ""; - if (!pubkey) { - return; - } - - if (!this.isUserLoggedIn()) { - this.handleVideoModalCommentLoginRequired(detail); - return; - } - - try { - await userBlocks.addBlock(pubkey, this.pubkey); - const snapshot = this.commentThreadService?.getSnapshot?.(); - if (snapshot) { - this.handleCommentThreadReady(snapshot); - } - this.showStatus?.("Author muted."); - } catch (error) { - devLogger.warn("[comment] Failed to mute author:", error); - this.showError("Failed to mute this author. Please try again."); - } - } - subscribeModalViewCount(pointer, pointerKey) { const viewEl = this.videoModal?.getViewCountElement() || null; if (!viewEl) { @@ -3900,6 +2086,7 @@ class Application { return "You do not have permission to perform that action."; case "nostr-unavailable": return "Unable to reach the configured Nostr relays. Please retry once your connection is restored."; + case "nostr-extension-missing": return "Connect a Nostr extension before editing moderation lists."; case "signature-failed": @@ -4572,12 +2759,50 @@ class Application { pubkey, profile, }); + } else { + devLogger.warn( + "[Application] ProfileIdentityController missing; profile identity was not refreshed in the DOM.", + ); + } + + const normalizedPubkey = + this.normalizeHexPubkey(pubkey) || + (typeof pubkey === "string" ? pubkey.trim() : ""); + if (!normalizedPubkey) { return; } - devLogger.warn( - "[Application] ProfileIdentityController missing; profile identity was not refreshed in the DOM.", - ); + const maybeDecorateVideo = (video) => { + if (!video || typeof video !== "object") { + return; + } + const videoPubkey = + this.normalizeHexPubkey(video.pubkey) || + (typeof video.pubkey === "string" ? video.pubkey.trim() : ""); + if (videoPubkey !== normalizedPubkey) { + return; + } + this.decorateVideoCreatorIdentity(video); + }; + + if (this.videosMap instanceof Map) { + for (const video of this.videosMap.values()) { + maybeDecorateVideo(video); + } + } + + if ( + this.videoListView && + Array.isArray(this.videoListView.currentVideos) + ) { + this.videoListView.currentVideos.forEach((video) => { + maybeDecorateVideo(video); + }); + } + + if (this.currentVideo) { + maybeDecorateVideo(this.currentVideo); + } } async publishVideoNote(payload, { onSuccess, suppressModalClose } = {}) { @@ -5327,13 +3552,32 @@ class Application { return false; } - const sessionActorPubkey = this.normalizeHexPubkey( - nostrClient?.sessionActor?.pubkey, - ); - if (sessionActorPubkey && sessionActorPubkey === normalizedPubkey) { + const clientPubkey = this.normalizeHexPubkey(nostrClient?.pubkey); + if (clientPubkey && clientPubkey !== normalizedPubkey) { return false; } + const sessionActor = nostrClient?.sessionActor || null; + const sessionActorPubkey = this.normalizeHexPubkey(sessionActor?.pubkey); + if (sessionActorPubkey && sessionActorPubkey !== normalizedPubkey) { + const rawPrivateKey = + typeof sessionActor?.privateKey === "string" + ? sessionActor.privateKey.trim() + : ""; + const hasEmbeddedPrivateKey = + rawPrivateKey.length > 0 && HEX64_REGEX.test(rawPrivateKey); + + const declaredSource = + typeof sessionActor?.source === "string" + ? sessionActor.source.trim() + : ""; + const isPersisted = sessionActor?.persisted === true; + + if (!hasEmbeddedPrivateKey || declaredSource || isPersisted) { + return false; + } + } + return true; } @@ -5421,6 +3665,34 @@ class Application { } } + refreshChromeElements() { + const doc = typeof document !== "undefined" ? document : null; + const findElement = (id) => { + if (!doc || typeof doc.getElementById !== "function") { + return null; + } + const element = doc.getElementById(id); + if (!element || typeof element.addEventListener !== "function") { + return null; + } + return element; + }; + + this.loginButton = findElement("loginButton"); + this.logoutButton = findElement("logoutButton"); + this.uploadButton = findElement("uploadButton"); + this.profileButton = findElement("profileButton"); + this.closeLoginModalBtn = findElement("closeLoginModal"); + + return { + loginButton: this.loginButton, + logoutButton: this.logoutButton, + uploadButton: this.uploadButton, + profileButton: this.profileButton, + closeLoginModalButton: this.closeLoginModalBtn, + }; + } + resolveSubscriptionsLink() { if (this.subscriptionsLink instanceof HTMLElement) { return this.subscriptionsLink; @@ -5437,7 +3709,20 @@ class Application { } hydrateSidebarNavigation() { + const chromeElements = this.refreshChromeElements(); this.resolveSubscriptionsLink(); + + if (this.appChromeController) { + if (typeof this.appChromeController.setElements === "function") { + this.appChromeController.setElements(chromeElements); + } else { + if (this.appChromeController.elements) { + Object.assign(this.appChromeController.elements, chromeElements); + } + this.appChromeController.initialize(); + } + } + this.syncAuthUiState(); } @@ -5491,7 +3776,7 @@ class Application { } this.applyAuthenticatedUiState(); - this.applyCommentComposerAuthState(); + this.commentController?.refreshAuthState?.(); const rawProviderId = typeof detail?.providerId === "string" ? detail.providerId.trim() : ""; @@ -5737,7 +4022,7 @@ class Application { } this.applyLoggedOutUiState(); - this.applyCommentComposerAuthState(); + this.commentController?.refreshAuthState?.(); try { await this.handleModerationSettingsChange({ @@ -5832,10 +4117,18 @@ class Application { /** * Cleanup resources on unload or modal close. + * + * When `preserveModals` is true the modal infrastructure is kept alive so the + * next playback session can reuse the existing controllers without + * reinitializing DOM bindings. */ - async cleanup({ preserveSubscriptions = false, preserveObservers = false } = {}) { + async cleanup({ + preserveSubscriptions = false, + preserveObservers = false, + preserveModals = false, + } = {}) { this.log( - `[cleanup] Requested (preserveSubscriptions=${preserveSubscriptions}, preserveObservers=${preserveObservers})` + `[cleanup] Requested (preserveSubscriptions=${preserveSubscriptions}, preserveObservers=${preserveObservers}, preserveModals=${preserveModals})` ); // Serialise teardown so overlapping calls (e.g. close button spam) don't // race each other and clobber a fresh playback setup. @@ -5850,7 +4143,7 @@ class Application { const runCleanup = async () => { this.log( - `[cleanup] Begin (preserveSubscriptions=${preserveSubscriptions}, preserveObservers=${preserveObservers})` + `[cleanup] Begin (preserveSubscriptions=${preserveSubscriptions}, preserveObservers=${preserveObservers}, preserveModals=${preserveModals})` ); try { this.cancelPendingViewLogging(); @@ -5922,6 +4215,29 @@ class Application { } } } + + this.commentController?.dispose({ resetUi: false }); + + if (!preserveModals) { + if (this.modalManager) { + try { + this.modalManager.teardown(); + } catch (error) { + devLogger.warn("[cleanup] Modal teardown failed:", error); + } + this.modalManager = null; + } + + if (this.bootstrapper) { + try { + this.bootstrapper.teardown(); + } catch (error) { + devLogger.warn("[cleanup] Bootstrap teardown failed:", error); + } + } + } + + // Tell webtorrent to cleanup await torrentClient.cleanup(); this.log("[cleanup] WebTorrent cleanup resolved."); @@ -6568,6 +4884,7 @@ class Application { await this.cleanup({ preserveSubscriptions: true, preserveObservers: true, + preserveModals: true, }); }; @@ -7216,7 +5533,15 @@ class Application { } const decoratedVideos = Array.isArray(videos) - ? videos.map((video) => this.decorateVideoModeration(video)) + ? videos.map((video) => { + const moderated = this.decorateVideoModeration(video); + const targetVideo = + moderated && typeof moderated === "object" ? moderated : video; + const withIdentity = this.decorateVideoCreatorIdentity(targetVideo); + return withIdentity && typeof withIdentity === "object" + ? withIdentity + : targetVideo; + }) : []; this.videoListView.render(decoratedVideos, metadata); @@ -7685,306 +6010,113 @@ class Application { return video; } - handleModerationOverride({ video, card }) { - if (!video || typeof video !== "object" || !video.id) { - return false; + initializeModerationActionController() { + if (this.moderationActionController) { + return this.moderationActionController; } - try { - setModerationOverride(video.id, { - showAnyway: true, - updatedAt: Date.now(), - }); - } catch (error) { - devLogger.warn("[Application] Failed to persist moderation override:", error); - } + this.moderationActionController = new ModerationActionController({ + services: { + setModerationOverride, + clearModerationOverride, + userBlocks, + }, + selectors: { + getVideoById: (id) => + this.videosMap instanceof Map && id ? this.videosMap.get(id) : null, + getCurrentVideo: () => this.currentVideo, + }, + actions: { + decorateVideoModeration: (video) => this.decorateVideoModeration(video), + resumePlayback: (video) => this.resumePendingModeratedPlayback(video), + refreshVideos: (payload) => this.onVideosShouldRefresh(payload), + showStatus: (message, options) => this.showStatus(message, options), + showError: (message) => this.showError(message), + describeBlockError: (error) => this.describeUserBlockActionError(error), + }, + auth: { + isLoggedIn: () => this.isUserLoggedIn(), + getViewerPubkey: () => this.pubkey, + normalizePubkey: (value) => this.normalizeHexPubkey(value), + }, + ui: { + refreshCardModerationUi: (card, options) => + this.refreshCardModerationUi(card, options), + dispatchModerationEvent: (eventName, detail) => + this.dispatchModerationEvent(eventName, detail), + }, + }); - const storedVideo = - this.videosMap instanceof Map && video.id ? this.videosMap.get(video.id) : null; - const target = storedVideo || video; - - if (target) { - if (target.moderation && typeof target.moderation === "object") { - if (target.moderation.hidden) { - delete target.moderation.hidden; - } - if (target.moderation.hideReason) { - delete target.moderation.hideReason; - } - if (target.moderation.hideCounts) { - delete target.moderation.hideCounts; - } - if (target.moderation.hideBypass) { - delete target.moderation.hideBypass; - } - } - this.decorateVideoModeration(target); - } - - if (this.currentVideo && this.currentVideo.id === video.id) { - if (this.currentVideo.moderation && typeof this.currentVideo.moderation === "object") { - if (this.currentVideo.moderation.hidden) { - delete this.currentVideo.moderation.hidden; - } - if (this.currentVideo.moderation.hideReason) { - delete this.currentVideo.moderation.hideReason; - } - if (this.currentVideo.moderation.hideCounts) { - delete this.currentVideo.moderation.hideCounts; - } - if (this.currentVideo.moderation.hideBypass) { - delete this.currentVideo.moderation.hideBypass; - } - } - this.decorateVideoModeration(this.currentVideo); - } - - if (card && typeof card.refreshModerationUi === "function") { - try { - card.refreshModerationUi(); - } catch (error) { - devLogger.warn("[Application] Failed to refresh moderation UI:", error); - } - } - - const doc = - (this.videoModal && this.videoModal.document) || - (typeof document !== "undefined" ? document : null); - if (doc && typeof doc.dispatchEvent === "function") { - try { - doc.dispatchEvent( - new CustomEvent("video:moderation-override", { - detail: { video: target }, - }), - ); - } catch (eventError) { - devLogger.warn( - "[Application] Failed to dispatch moderation override event:", - eventError, - ); - } - } - - this.resumePendingModeratedPlayback(target); - - return true; + return this.moderationActionController; } - async handleModerationBlock({ video, card }) { - if (!video || typeof video !== "object" || !video.id) { - return false; - } - - if (!this.isUserLoggedIn()) { - this.showStatus("Log in to block accounts.", { showSpinner: false }); - return false; - } - - const viewerHex = this.normalizeHexPubkey(this.pubkey); - if (!viewerHex) { - this.showError("Select a profile before blocking accounts."); - return false; - } - - const targetHex = this.normalizeHexPubkey(video?.pubkey); - if (!targetHex) { - this.showError("Unable to determine which account to block."); - return false; - } - - if (viewerHex === targetHex) { - this.showError("You cannot block yourself."); + refreshCardModerationUi(card, { reason } = {}) { + if (!card || typeof card.refreshModerationUi !== "function") { return false; } try { - await userBlocks.ensureLoaded(viewerHex); + card.refreshModerationUi(); + return true; } catch (error) { + const suffix = reason ? ` ${reason}` : ""; devLogger.warn( - "[Application] Failed to load block list before blocking:", + `[Application] Failed to refresh moderation UI${suffix}:`, error, ); - this.showError("Unable to load your block list. Please try again."); return false; } - - let alreadyBlocked = - typeof userBlocks.isBlocked === "function" && - userBlocks.isBlocked(targetHex); - let blockApplied = false; - - if (!alreadyBlocked) { - try { - const result = await userBlocks.addBlock(targetHex, viewerHex); - alreadyBlocked = true; - blockApplied = result?.already !== true; - } catch (error) { - const message = - (typeof this.describeUserBlockActionError === "function" - ? this.describeUserBlockActionError(error) - : "") || "Failed to block this creator. Please try again."; - this.showError(message); - devLogger.warn("[Application] Failed to block creator:", error); - return false; - } - } - - if (alreadyBlocked) { - const statusMessage = blockApplied - ? "Creator blocked. Their videos will disappear from your feed." - : "Creator already blocked. Their videos will disappear from your feed."; - this.showStatus(statusMessage, { showSpinner: false }); - } - - try { - clearModerationOverride(video.id); - } catch (error) { - devLogger.warn("[Application] Failed to clear moderation override:", error); - } - - const storedVideo = - this.videosMap instanceof Map && video.id ? this.videosMap.get(video.id) : null; - const target = storedVideo || video; - - const resetModerationState = (subject) => { - if (!subject || typeof subject !== "object") { - return; - } - const moderation = - subject.moderation && typeof subject.moderation === "object" - ? subject.moderation - : null; - if (!moderation) { - return; - } - if (moderation.viewerOverride) { - delete moderation.viewerOverride; - } - if (moderation.hideBypass) { - delete moderation.hideBypass; - } - }; - - if (target) { - resetModerationState(target); - this.decorateVideoModeration(target); - } - - if (this.currentVideo && this.currentVideo.id === video.id) { - resetModerationState(this.currentVideo); - this.decorateVideoModeration(this.currentVideo); - } - - if (card && typeof card.refreshModerationUi === "function") { - try { - card.refreshModerationUi(); - } catch (error) { - devLogger.warn( - "[Application] Failed to refresh moderation UI after block:", - error, - ); - } - } - - const doc = - (this.videoModal && this.videoModal.document) || - (typeof document !== "undefined" ? document : null); - if (doc && typeof doc.dispatchEvent === "function") { - try { - const detail = { video: target }; - doc.dispatchEvent(new CustomEvent("video:moderation-block", { detail })); - doc.dispatchEvent(new CustomEvent("video:moderation-hide", { detail })); - } catch (eventError) { - devLogger.warn( - "[Application] Failed to dispatch moderation block event:", - eventError, - ); - } - } - - try { - await this.onVideosShouldRefresh({ reason: "user-block-update" }); - } catch (error) { - devLogger.warn( - "[Application] Failed to refresh videos after block:", - error, - ); - } - - return true; } - handleModerationHide({ video, card }) { - if (!video || typeof video !== "object" || !video.id) { + dispatchModerationEvent(eventName, detail = {}) { + const doc = + (this.videoModal && this.videoModal.document) || + (typeof document !== "undefined" ? document : null); + + if (!doc || typeof doc.dispatchEvent !== "function") { return false; } try { - clearModerationOverride(video.id); + doc.dispatchEvent(new CustomEvent(eventName, { detail })); + return true; } catch (error) { - devLogger.warn("[Application] Failed to clear moderation override:", error); + const eventLabels = { + "video:moderation-override": "moderation override event", + "video:moderation-block": "moderation block event", + "video:moderation-hide": "moderation hide event", + }; + const label = eventLabels[eventName] || eventName; + devLogger.warn(`[Application] Failed to dispatch ${label}:`, error); + return false; + } + } + + handleModerationOverride(payload = {}) { + const controller = this.initializeModerationActionController(); + if (!controller) { + return false; } - const storedVideo = - this.videosMap instanceof Map && video.id - ? this.videosMap.get(video.id) - : null; - const target = storedVideo || video; + return controller.handleOverride(payload); + } - const resetOverrideState = (subject) => { - if (!subject || typeof subject !== "object") { - return; - } - const moderation = - subject.moderation && typeof subject.moderation === "object" - ? subject.moderation - : null; - if (!moderation) { - return; - } - if (moderation.viewerOverride) { - delete moderation.viewerOverride; - } - }; - - if (target) { - resetOverrideState(target); - this.decorateVideoModeration(target); + async handleModerationBlock(payload = {}) { + const controller = this.initializeModerationActionController(); + if (!controller) { + return false; } - if (this.currentVideo && this.currentVideo.id === video.id) { - resetOverrideState(this.currentVideo); - this.decorateVideoModeration(this.currentVideo); + return controller.handleBlock(payload); + } + + handleModerationHide(payload = {}) { + const controller = this.initializeModerationActionController(); + if (!controller) { + return false; } - if (card && typeof card.refreshModerationUi === "function") { - try { - card.refreshModerationUi(); - } catch (error) { - devLogger.warn( - "[Application] Failed to refresh moderation UI after hide:", - error, - ); - } - } - - const doc = - (this.videoModal && this.videoModal.document) || - (typeof document !== "undefined" ? document : null); - if (doc && typeof doc.dispatchEvent === "function") { - try { - doc.dispatchEvent( - new CustomEvent("video:moderation-hide", { detail: { video: target } }), - ); - } catch (eventError) { - devLogger.warn( - "[Application] Failed to dispatch moderation hide event:", - eventError, - ); - } - } - - return true; + return controller.handleHide(payload); } getVideoAddressPointer(video) { @@ -9081,11 +7213,32 @@ class Application { ? index : null; + const ensureCreatorIdentity = (video) => { + if ( + !video || + typeof video !== "object" || + typeof this.decorateVideoCreatorIdentity !== "function" + ) { + return video; + } + try { + const decorated = this.decorateVideoCreatorIdentity(video); + return decorated && typeof decorated === "object" ? decorated : video; + } catch (error) { + devLogger.warn( + "[Application] Failed to decorate video identity for action target:", + error, + ); + return video; + } + }; + const initialVideo = providedVideo && typeof providedVideo === "object" ? providedVideo : null; + const preparedInitialVideo = ensureCreatorIdentity(initialVideo); const providedId = - initialVideo && typeof initialVideo.id === "string" - ? initialVideo.id.trim() + preparedInitialVideo && typeof preparedInitialVideo.id === "string" + ? preparedInitialVideo.id.trim() : ""; const targetEventId = trimmedEventId || providedId; @@ -9094,9 +7247,9 @@ class Application { : []; if (providedId) { - this.videosMap.set(providedId, initialVideo); + this.videosMap.set(providedId, preparedInitialVideo); if (!trimmedEventId || providedId === trimmedEventId) { - return initialVideo; + return preparedInitialVideo; } } @@ -9104,8 +7257,9 @@ class Application { if (targetEventId) { const match = list.find((video) => video?.id === targetEventId); if (match) { - this.videosMap.set(match.id, match); - return match; + const preparedMatch = ensureCreatorIdentity(match); + this.videosMap.set(preparedMatch.id, preparedMatch); + return preparedMatch; } } if ( @@ -9115,8 +7269,9 @@ class Application { ) { const match = list[normalizedIndex]; if (match) { - this.videosMap.set(match.id, match); - return match; + const preparedMatch = ensureCreatorIdentity(match); + this.videosMap.set(preparedMatch.id, preparedMatch); + return preparedMatch; } } } @@ -9130,20 +7285,23 @@ class Application { const activeVideos = nostrClient.getActiveVideos(); const fromActive = activeVideos.find((video) => video.id === targetEventId); if (fromActive) { - this.videosMap.set(fromActive.id, fromActive); - return fromActive; + const preparedActive = ensureCreatorIdentity(fromActive); + this.videosMap.set(preparedActive.id, preparedActive); + return preparedActive; } const fromAll = nostrClient.allEvents.get(targetEventId); if (fromAll) { - this.videosMap.set(fromAll.id, fromAll); - return fromAll; + const preparedFromAll = ensureCreatorIdentity(fromAll); + this.videosMap.set(preparedFromAll.id, preparedFromAll); + return preparedFromAll; } const fetched = await nostrClient.getEventById(targetEventId); if (fetched) { - this.videosMap.set(fetched.id, fetched); - return fetched; + const preparedFetched = ensureCreatorIdentity(fetched); + this.videosMap.set(preparedFetched.id, preparedFetched); + return preparedFetched; } } @@ -9152,8 +7310,9 @@ class Application { if (normalizedIndex >= 0 && normalizedIndex < activeVideos.length) { const candidate = activeVideos[normalizedIndex]; if (candidate) { - this.videosMap.set(candidate.id, candidate); - return candidate; + const preparedCandidate = ensureCreatorIdentity(candidate); + this.videosMap.set(preparedCandidate.id, preparedCandidate); + return preparedCandidate; } } } @@ -10220,6 +8379,22 @@ class Application { ? Math.floor(video.created_at) : null; + const normalizedCreatorPubkey = + this.normalizeHexPubkey(video.pubkey) || video.pubkey; + const cachedCreatorProfileEntry = + normalizedCreatorPubkey && typeof this.getProfileCacheEntry === "function" + ? this.getProfileCacheEntry(normalizedCreatorPubkey) + : null; + const cachedCreatorProfile = + cachedCreatorProfileEntry && + typeof cachedCreatorProfileEntry === "object" + ? cachedCreatorProfileEntry.profile || null + : null; + const initialLightningAddress = + typeof video.lightningAddress === "string" + ? video.lightningAddress.trim() + : ""; + this.currentVideo = { ...video, url: trimmedUrl, @@ -10228,7 +8403,7 @@ class Application { magnetCandidate || fallbackMagnetForCandidate || legacyInfoHash || "", torrentSupported: magnetSupported, legacyInfoHash: video.legacyInfoHash || legacyInfoHash, - lightningAddress: null, + lightningAddress: initialLightningAddress || null, lastEditedAt: normalizedEditedAt, }; @@ -10236,6 +8411,30 @@ class Application { const modalTags = collectVideoTags(this.currentVideo); this.currentVideo.displayTags = modalTags; + const creatorNpub = this.safeEncodeNpub(video.pubkey) || video.pubkey; + const displayNpub = formatShortNpub(creatorNpub) || creatorNpub; + const initialCreatorProfile = this.resolveModalCreatorProfile({ + video: this.currentVideo, + pubkey: normalizedCreatorPubkey, + cachedProfile: cachedCreatorProfile, + }); + this.currentVideo.creatorName = initialCreatorProfile.name; + this.currentVideo.creatorPicture = initialCreatorProfile.picture; + this.currentVideo.creatorNpub = displayNpub; + if (this.currentVideo.creator && typeof this.currentVideo.creator === "object") { + this.currentVideo.creator = { + ...this.currentVideo.creator, + name: initialCreatorProfile.name, + picture: initialCreatorProfile.picture, + pubkey: normalizedCreatorPubkey, + }; + } else { + this.currentVideo.creator = { + name: initialCreatorProfile.name, + picture: initialCreatorProfile.picture, + pubkey: normalizedCreatorPubkey, + }; + } this.updateModalSimilarContent({ activeVideo: this.currentVideo }); if (Number.isFinite(knownPostedAt)) { @@ -10269,8 +8468,6 @@ class Application { this.currentVideoPointer, this.currentVideoPointerKey ); - this.subscribeModalComments(this.currentVideo); - this.syncModalMoreMenuData(); this.currentMagnetUri = sanitizedMagnet || null; @@ -10286,8 +8483,8 @@ class Application { )}`; window.history.pushState({}, "", pushUrl); - this.zapController?.setVisibility(false); this.zapController?.resetState(); + this.zapController?.setVisibility(Boolean(this.currentVideo.lightningAddress)); const magnetInput = sanitizedMagnet || @@ -10299,6 +8496,8 @@ class Application { await this.showModalWithPoster(this.currentVideo); + this.commentController?.load(this.currentVideo); + const playbackOptions = { url: trimmedUrl, magnet: magnetInput, @@ -10322,52 +8521,38 @@ class Application { playbackPromise = this.playVideoWithFallback(playbackOptions); } - let lightningAddress = ""; - let creatorProfile = { - name: "Unknown", - picture: `https://robohash.org/${video.pubkey}`, - }; - try { - const userEvents = await nostrClient.pool.list(nostrClient.relays, [ - { kinds: [0], authors: [video.pubkey], limit: 1 }, - ]); - if (userEvents.length > 0 && userEvents[0]?.content) { - const data = JSON.parse(userEvents[0].content); - lightningAddress = (data.lud16 || data.lud06 || "").trim(); - creatorProfile = { - name: data.name || data.display_name || "Unknown", - picture: data.picture || `https://robohash.org/${video.pubkey}`, - }; - } - } catch (error) { - this.log("Error fetching creator profile:", error); - } - - this.zapController?.setVisibility(!!lightningAddress); - if (this.currentVideo) { - this.currentVideo.lightningAddress = lightningAddress || null; - } - - const creatorNpub = this.safeEncodeNpub(video.pubkey) || video.pubkey; if (this.videoModal) { const timestampPayload = this.buildModalTimestampPayload({ postedAt: this.currentVideo?.rootCreatedAt ?? null, editedAt: normalizedEditedAt, }); - const displayNpub = formatShortNpub(creatorNpub); this.videoModal.updateMetadata({ title: video.title || "Untitled", description: video.description || "No description available.", timestamps: timestampPayload, tags: modalTags, creator: { - name: creatorProfile.name, - avatarUrl: creatorProfile.picture, + name: initialCreatorProfile.name, + avatarUrl: initialCreatorProfile.picture, npub: displayNpub, }, }); } + const profileRequestToken = Symbol("modal-profile-request"); + this.modalCreatorProfileRequestToken = profileRequestToken; + this.fetchModalCreatorProfile({ + pubkey: normalizedCreatorPubkey, + displayNpub, + cachedProfile: cachedCreatorProfile, + requestToken: profileRequestToken, + }).catch((error) => { + devLogger.error( + "[Application] Failed to fetch creator profile for modal:", + error, + ); + }); + this.ensureModalPostedTimestamp(this.currentVideo); const playbackResult = @@ -10600,9 +8785,7 @@ class Application { this.currentVideoPointerKey = null; this.subscribeModalViewCount(null, null); this.subscribeModalReactions(null, null); - this.subscribeModalComments(null); this.pendingModeratedPlayback = null; - const sanitizedUrl = typeof url === "string" ? url.trim() : ""; const trimmedMagnet = typeof magnet === "string" ? magnet.trim() : ""; const decodedMagnet = safeDecodeMagnet(trimmedMagnet); @@ -10665,7 +8848,9 @@ class Application { await this.showModalWithPoster(this.currentVideo, hasTrigger ? { trigger } : {}); - const urlObj = new URL(window.location.href); + this.commentController?.load(null); + + const shareUrl = this.buildShareUrlFromEventId(this.currentVideo.id); urlObj.searchParams.delete("v"); const cleaned = `${urlObj.pathname}${urlObj.search}${urlObj.hash}`; window.history.replaceState({}, "", cleaned); @@ -10723,6 +8908,428 @@ class Application { return null; } + selectPreferredCreatorName(candidates = []) { + for (const candidate of candidates) { + if (typeof candidate !== "string") { + continue; + } + const trimmed = candidate.trim(); + if (!trimmed) { + continue; + } + if (HEX64_REGEX.test(trimmed)) { + continue; + } + return trimmed; + } + return ""; + } + + selectPreferredCreatorPicture(candidates = []) { + for (const candidate of candidates) { + if (typeof candidate !== "string") { + continue; + } + const sanitized = sanitizeProfileMediaUrl(candidate); + if (sanitized) { + return sanitized; + } + } + return ""; + } + + resolveCreatorProfileFromSources({ + video, + pubkey, + cachedProfile = null, + fetchedProfile = null, + fallbackAvatar, + } = {}) { + const normalizedPubkey = + typeof pubkey === "string" && pubkey.trim() ? pubkey.trim() : ""; + const fallbackAvatarCandidate = + typeof fallbackAvatar === "string" && fallbackAvatar.trim() + ? fallbackAvatar.trim() + : normalizedPubkey + ? `https://robohash.org/${normalizedPubkey}` + : "assets/svg/default-profile.svg"; + const defaultAvatar = + sanitizeProfileMediaUrl(fallbackAvatarCandidate) || + fallbackAvatarCandidate || + "assets/svg/default-profile.svg"; + + const nameCandidates = []; + const pictureCandidates = []; + + const collectFromSource = (source) => { + if (!source || typeof source !== "object") { + return; + } + const names = [ + source.display_name, + source.displayName, + source.name, + source.username, + ]; + names.forEach((value) => { + if (typeof value === "string") { + nameCandidates.push(value); + } + }); + const pictures = [source.picture, source.image, source.photo]; + pictures.forEach((value) => { + if (typeof value === "string") { + pictureCandidates.push(value); + } + }); + }; + + collectFromSource(fetchedProfile); + collectFromSource(cachedProfile); + + if (video && typeof video === "object") { + collectFromSource(video.creator); + if (typeof video.creatorName === "string") { + nameCandidates.push(video.creatorName); + } + if (typeof video.creatorPicture === "string") { + pictureCandidates.push(video.creatorPicture); + } + collectFromSource(video.author); + if (typeof video.authorName === "string") { + nameCandidates.push(video.authorName); + } + if (typeof video.authorPicture === "string") { + pictureCandidates.push(video.authorPicture); + } + collectFromSource(video.profile); + const extraNames = [ + video.shortNpub, + video.creatorNpub, + video.npub, + video.authorNpub, + ]; + extraNames.forEach((value) => { + if (typeof value === "string") { + nameCandidates.push(value); + } + }); + } + + const resolvedName = + this.selectPreferredCreatorName(nameCandidates) || "Unknown"; + const resolvedPicture = + this.selectPreferredCreatorPicture(pictureCandidates) || defaultAvatar; + + return { name: resolvedName, picture: resolvedPicture }; + } + + resolveModalCreatorProfile({ + video, + pubkey, + cachedProfile = null, + fetchedProfile = null, + } = {}) { + return this.resolveCreatorProfileFromSources({ + video, + pubkey, + cachedProfile, + fetchedProfile, + }); + } + + decorateVideoCreatorIdentity(video) { + if (!video || typeof video !== "object") { + return video; + } + + const normalizedPubkey = + this.normalizeHexPubkey(video.pubkey) || + (typeof video.pubkey === "string" ? video.pubkey.trim() : ""); + if (!normalizedPubkey) { + return video; + } + + let cachedProfile = null; + if (typeof this.getProfileCacheEntry === "function") { + const cacheEntry = this.getProfileCacheEntry(normalizedPubkey); + if (cacheEntry && typeof cacheEntry === "object") { + cachedProfile = cacheEntry.profile || null; + } + } + + const resolvedProfile = this.resolveCreatorProfileFromSources({ + video, + pubkey: normalizedPubkey, + cachedProfile, + }); + + if (!video.creator || typeof video.creator !== "object") { + video.creator = {}; + } + + if (!video.creator.pubkey) { + video.creator.pubkey = normalizedPubkey; + } + + if (resolvedProfile.name) { + video.creator.name = resolvedProfile.name; + if ( + typeof video.creatorName !== "string" || + !video.creatorName.trim() || + video.creatorName === "Unknown" + ) { + video.creatorName = resolvedProfile.name; + } + if ( + typeof video.authorName !== "string" || + !video.authorName.trim() || + video.authorName === "Unknown" + ) { + video.authorName = resolvedProfile.name; + } + } + + if (resolvedProfile.picture) { + video.creator.picture = resolvedProfile.picture; + video.creatorPicture = resolvedProfile.picture; + if ( + typeof video.authorPicture !== "string" || + !video.authorPicture.trim() + ) { + video.authorPicture = resolvedProfile.picture; + } + } + + const encodedNpub = this.safeEncodeNpub(normalizedPubkey); + if (encodedNpub) { + const shortNpub = formatShortNpub(encodedNpub) || encodedNpub; + if (typeof video.npub !== "string" || !video.npub.trim()) { + video.npub = encodedNpub; + } + if (typeof video.shortNpub !== "string" || !video.shortNpub.trim()) { + video.shortNpub = shortNpub; + } + if ( + typeof video.creatorNpub !== "string" || + !video.creatorNpub.trim() + ) { + video.creatorNpub = shortNpub; + } + } + + return video; + } + + async fetchModalCreatorProfile({ + pubkey, + displayNpub = "", + cachedProfile = null, + requestToken = null, + } = {}) { + const normalized = this.normalizeHexPubkey(pubkey); + if (!normalized) { + return; + } + + const relayList = + Array.isArray(nostrClient?.relays) && nostrClient.relays.length + ? nostrClient.relays + : null; + if (!relayList || !nostrClient?.pool || typeof nostrClient.pool.list !== "function") { + return; + } + + const events = await nostrClient.pool.list(relayList, [ + { kinds: [0], authors: [normalized], limit: 1 }, + ]); + + if (this.modalCreatorProfileRequestToken !== requestToken) { + return; + } + + const newest = Array.isArray(events) + ? events.reduce((latest, event) => { + if (!event || typeof event !== "object") { + return latest; + } + const eventPubkey = this.normalizeHexPubkey(event.pubkey); + if (eventPubkey && eventPubkey !== normalized) { + return latest; + } + const createdAt = Number.isFinite(event.created_at) ? event.created_at : 0; + if (!latest || createdAt > latest.createdAt) { + return { createdAt, event }; + } + return latest; + }, null) + : null; + + if (!newest || !newest.event) { + if (this.modalCreatorProfileRequestToken === requestToken) { + this.modalCreatorProfileRequestToken = null; + } + return; + } + + let parsed = null; + try { + parsed = newest.event.content ? JSON.parse(newest.event.content) : null; + } catch (error) { + devLogger.warn( + `[Application] Failed to parse creator profile content for ${normalized}:`, + error, + ); + if (this.modalCreatorProfileRequestToken === requestToken) { + this.modalCreatorProfileRequestToken = null; + } + return; + } + + if (this.modalCreatorProfileRequestToken !== requestToken) { + return; + } + + const parsedLud16 = + typeof parsed?.lud16 === "string" ? parsed.lud16.trim() : ""; + const parsedLud06 = + typeof parsed?.lud06 === "string" ? parsed.lud06.trim() : ""; + const lightningAddressCandidate = (() => { + const fields = [parsedLud16, parsedLud06]; + for (const field of fields) { + if (typeof field !== "string") { + continue; + } + const trimmed = field.trim(); + if (trimmed) { + return trimmed; + } + } + return ""; + })(); + + const fetchedProfile = { + display_name: parsed?.display_name, + name: parsed?.name, + username: parsed?.username, + picture: parsed?.picture, + image: parsed?.image, + photo: parsed?.photo, + }; + + const resolvedProfile = this.resolveModalCreatorProfile({ + video: this.currentVideo, + pubkey: normalized, + cachedProfile, + fetchedProfile, + }); + + if (this.modalCreatorProfileRequestToken !== requestToken) { + return; + } + + const activeVideoPubkey = this.normalizeHexPubkey(this.currentVideo?.pubkey); + if (activeVideoPubkey && activeVideoPubkey !== normalized) { + return; + } + + const nextLightning = lightningAddressCandidate || ""; + const previousLightning = + typeof this.currentVideo?.lightningAddress === "string" + ? this.currentVideo.lightningAddress + : ""; + + if (this.currentVideo) { + this.currentVideo.lightningAddress = nextLightning ? nextLightning : null; + this.currentVideo.creatorName = resolvedProfile.name; + this.currentVideo.creatorPicture = resolvedProfile.picture; + this.currentVideo.creatorNpub = displayNpub; + if (this.currentVideo.creator && typeof this.currentVideo.creator === "object") { + this.currentVideo.creator = { + ...this.currentVideo.creator, + name: resolvedProfile.name, + picture: resolvedProfile.picture, + pubkey: normalized, + lightningAddress: nextLightning ? nextLightning : null, + }; + } else { + this.currentVideo.creator = { + name: resolvedProfile.name, + picture: resolvedProfile.picture, + pubkey: normalized, + lightningAddress: nextLightning ? nextLightning : null, + }; + } + } + + if (this.videoModal) { + this.videoModal.updateMetadata({ + creator: { + name: resolvedProfile.name, + avatarUrl: resolvedProfile.picture, + npub: displayNpub, + }, + }); + } + + this.zapController?.setVisibility(Boolean(this.currentVideo?.lightningAddress)); + + const sanitizedFetchedPicture = sanitizeProfileMediaUrl( + parsed?.picture || parsed?.image || parsed?.photo || "", + ); + const fetchedNameCandidate = this.selectPreferredCreatorName([ + parsed?.display_name, + parsed?.name, + parsed?.username, + ]); + + const cachedLightning = + typeof cachedProfile?.lightningAddress === "string" + ? cachedProfile.lightningAddress.trim() + : ""; + const shouldUpdateCache = + Boolean(fetchedNameCandidate) || + Boolean(sanitizedFetchedPicture) || + cachedLightning !== nextLightning || + previousLightning !== nextLightning; + + if (shouldUpdateCache) { + try { + const profileForCache = { + name: fetchedNameCandidate || resolvedProfile.name, + picture: sanitizedFetchedPicture || resolvedProfile.picture, + }; + + if (parsedLud16) { + profileForCache.lud16 = parsedLud16; + } + + if (parsedLud06) { + profileForCache.lud06 = parsedLud06; + } + + if (nextLightning) { + profileForCache.lightningAddress = nextLightning; + } + + this.setProfileCacheEntry( + normalized, + profileForCache, + { persist: false, reason: "modal-profile-fetch" }, + ); + } catch (error) { + devLogger.warn( + `[Application] Failed to update profile cache for ${normalized}:`, + error, + ); + } + } + + if (this.modalCreatorProfileRequestToken === requestToken) { + this.modalCreatorProfileRequestToken = null; + } + } + normalizeReactionCount(value) { if (Number.isFinite(value)) { return Math.max(0, Math.round(Number(value))); @@ -10992,6 +9599,18 @@ class Application { this.teardownModalViewCountSubscription(); this.videoModalReadyPromise = null; + if (this.moderationActionController) { + try { + this.moderationActionController.destroy(); + } catch (error) { + devLogger.warn( + "[Application] Failed to destroy moderation action controller:", + error, + ); + } + this.moderationActionController = null; + } + if (this.statusAutoHideHandle) { const ownerDocument = this.statusContainer?.ownerDocument || @@ -11093,217 +9712,25 @@ class Application { this.unsubscribeFromNostrService = null; } - if (this.uploadModal && this.boundUploadSubmitHandler) { - this.uploadModal.removeEventListener( - "upload:submit", - this.boundUploadSubmitHandler - ); - this.boundUploadSubmitHandler = null; - } - if (typeof this.uploadModal?.destroy === "function") { + if (this.commentController) { try { - this.uploadModal.destroy(); + this.commentController.destroy({ resetUi: false }); } catch (error) { - devLogger.warn("[Application] Failed to destroy upload modal:", error); + devLogger.warn( + "[Application] Failed to destroy comment controller:", + error, + ); } + this.commentController = null; } - if (this.editModal) { - if (this.boundEditModalSubmitHandler) { - this.editModal.removeEventListener( - "video:edit-submit", - this.boundEditModalSubmitHandler - ); - this.boundEditModalSubmitHandler = null; - } - if (this.boundEditModalCancelHandler) { - this.editModal.removeEventListener( - "video:edit-cancel", - this.boundEditModalCancelHandler - ); - this.boundEditModalCancelHandler = null; - } - if (typeof this.editModal.destroy === "function") { - try { - this.editModal.destroy(); - } catch (error) { - devLogger.warn("[Application] Failed to destroy edit modal:", error); - } - } - } - - if (this.revertModal && this.boundRevertConfirmHandler) { - this.revertModal.removeEventListener( - "video:revert-confirm", - this.boundRevertConfirmHandler - ); - this.boundRevertConfirmHandler = null; - } - if (typeof this.revertModal?.destroy === "function") { + if (this.modalManager) { try { - this.revertModal.destroy(); + this.modalManager.teardown(); } catch (error) { - devLogger.warn("[Application] Failed to destroy revert modal:", error); - } - } - - if (this.deleteModal && this.boundDeleteConfirmHandler) { - this.deleteModal.removeEventListener( - "video:delete-confirm", - this.boundDeleteConfirmHandler - ); - this.boundDeleteConfirmHandler = null; - } - if (this.deleteModal && this.boundDeleteCancelHandler) { - this.deleteModal.removeEventListener( - "video:delete-cancel", - this.boundDeleteCancelHandler - ); - this.boundDeleteCancelHandler = null; - } - if (typeof this.deleteModal?.destroy === "function") { - try { - this.deleteModal.destroy(); - } catch (error) { - devLogger.warn("[Application] Failed to destroy delete modal:", error); - } - } - - if (this.videoModal) { - this.teardownModalCommentSubscription({ resetUi: false }); - if (this.boundVideoModalCloseHandler) { - this.videoModal.removeEventListener( - "modal:close", - this.boundVideoModalCloseHandler - ); - this.boundVideoModalCloseHandler = null; - } - if (this.boundVideoModalCopyHandler) { - this.videoModal.removeEventListener( - "video:copy-magnet", - this.boundVideoModalCopyHandler - ); - this.boundVideoModalCopyHandler = null; - } - if (this.boundVideoModalShareHandler) { - this.videoModal.removeEventListener( - "video:share", - this.boundVideoModalShareHandler - ); - this.boundVideoModalShareHandler = null; - } - if (this.boundVideoModalModerationOverrideHandler) { - this.videoModal.removeEventListener( - "video:moderation-override", - this.boundVideoModalModerationOverrideHandler, - ); - this.boundVideoModalModerationOverrideHandler = null; - } - if (this.boundVideoModalTagActivateHandler) { - this.videoModal.removeEventListener( - "tag:activate", - this.boundVideoModalTagActivateHandler, - ); - this.boundVideoModalTagActivateHandler = null; - } - if (this.boundVideoModalSimilarSelectHandler) { - this.videoModal.removeEventListener( - "similar:select", - this.boundVideoModalSimilarSelectHandler - ); - this.boundVideoModalSimilarSelectHandler = null; - } - if (this.boundVideoModalCreatorHandler) { - this.videoModal.removeEventListener( - "creator:navigate", - this.boundVideoModalCreatorHandler - ); - this.boundVideoModalCreatorHandler = null; - } - if (this.boundVideoModalZapHandler) { - this.videoModal.removeEventListener( - "video:zap", - this.boundVideoModalZapHandler - ); - this.boundVideoModalZapHandler = null; - } - if (this.boundVideoModalZapOpenHandler) { - this.videoModal.removeEventListener( - "zap:open", - this.boundVideoModalZapOpenHandler - ); - this.boundVideoModalZapOpenHandler = null; - } - if (this.boundVideoModalZapCloseHandler) { - this.videoModal.removeEventListener( - "zap:close", - this.boundVideoModalZapCloseHandler - ); - this.boundVideoModalZapCloseHandler = null; - } - if (this.boundVideoModalZapAmountHandler) { - this.videoModal.removeEventListener( - "zap:amount-change", - this.boundVideoModalZapAmountHandler - ); - this.boundVideoModalZapAmountHandler = null; - } - if (this.boundVideoModalZapCommentHandler) { - this.videoModal.removeEventListener( - "zap:comment-change", - this.boundVideoModalZapCommentHandler - ); - this.boundVideoModalZapCommentHandler = null; - } - if (this.boundVideoModalZapWalletHandler) { - this.videoModal.removeEventListener( - "zap:wallet-link", - this.boundVideoModalZapWalletHandler - ); - this.boundVideoModalZapWalletHandler = null; - } - if (this.boundVideoModalCommentSubmitHandler) { - this.videoModal.removeEventListener( - "comment:submit", - this.boundVideoModalCommentSubmitHandler - ); - this.boundVideoModalCommentSubmitHandler = null; - } - if (this.boundVideoModalCommentRetryHandler) { - this.videoModal.removeEventListener( - "comment:retry", - this.boundVideoModalCommentRetryHandler - ); - this.boundVideoModalCommentRetryHandler = null; - } - if (this.boundVideoModalCommentLoadMoreHandler) { - this.videoModal.removeEventListener( - "comment:load-more", - this.boundVideoModalCommentLoadMoreHandler - ); - this.boundVideoModalCommentLoadMoreHandler = null; - } - if (this.boundVideoModalCommentLoginHandler) { - this.videoModal.removeEventListener( - "comment:login-required", - this.boundVideoModalCommentLoginHandler - ); - this.boundVideoModalCommentLoginHandler = null; - } - if (this.boundVideoModalCommentMuteHandler) { - this.videoModal.removeEventListener( - "comment:mute-author", - this.boundVideoModalCommentMuteHandler - ); - this.boundVideoModalCommentMuteHandler = null; - } - if (typeof this.videoModal.destroy === "function") { - try { - this.videoModal.destroy(); - } catch (error) { - devLogger.warn("[Application] Failed to destroy video modal:", error); - } + devLogger.warn("[Application] Modal teardown failed:", error); } + this.modalManager = null; } this.closeTagPreferenceMenus({ restoreFocus: false }); @@ -11315,20 +9742,22 @@ class Application { if (this.moreMenuController) { this.moreMenuController.detachVideoListView(); } - this.videoListView.setPlaybackHandler(null); - this.videoListView.setEditHandler(null); - this.videoListView.setRevertHandler(null); - this.videoListView.setDeleteHandler(null); - if (typeof this.videoListView.setTagPreferenceStateResolver === "function") { - this.videoListView.setTagPreferenceStateResolver(null); - } - if (typeof this.videoListView.setTagActivationHandler === "function") { - this.videoListView.setTagActivationHandler(null); - } - this.videoListViewPlaybackHandler = null; - this.videoListViewEditHandler = null; - this.videoListViewRevertHandler = null; - this.videoListViewDeleteHandler = null; + this.videoListView.setPlaybackHandler(null); + this.videoListView.setEditHandler(null); + this.videoListView.setRevertHandler(null); + this.videoListView.setDeleteHandler(null); + if ( + typeof this.videoListView.setTagPreferenceStateResolver === "function" + ) { + this.videoListView.setTagPreferenceStateResolver(null); + } + if (typeof this.videoListView.setTagActivationHandler === "function") { + this.videoListView.setTagActivationHandler(null); + } + this.videoListViewPlaybackHandler = null; + this.videoListViewEditHandler = null; + this.videoListViewRevertHandler = null; + this.videoListViewDeleteHandler = null; try { this.videoListView.destroy(); } catch (error) { @@ -11370,6 +9799,14 @@ class Application { } this.loginModalController = null; } + if (this.bootstrapper) { + try { + this.bootstrapper.teardown(); + } catch (error) { + devLogger.warn("[Application] Bootstrap teardown failed:", error); + } + } + if (this.commentThreadService?.setCallbacks) { this.commentThreadService.setCallbacks({ diff --git a/js/channelProfile.js b/js/channelProfile.js index 3c8623cf..0d33fb1f 100644 --- a/js/channelProfile.js +++ b/js/channelProfile.js @@ -37,10 +37,12 @@ import { getCachedLightningEntry, getCachedMetadataByUrl, getCachedPlatformLightningAddress, + isZapAllowanceExhaustedError, isMetadataEntryFresh, normalizeLightningAddressKey, rememberLightningMetadata, setCachedPlatformLightningAddress, + buildZapAllowanceExhaustedMessage, validateInvoiceAmount } from "./payments/zapSharedState.js"; import { splitAndZap } from "./payments/zapSplit.js"; @@ -54,7 +56,8 @@ import { getPlatformLightningAddress } from "./payments/platformAddress.js"; import { devLogger, userLogger } from "./utils/logger.js"; import { ensureWallet, - sendPayment as sendWalletPayment + sendPayment as sendWalletPayment, + resetWalletClient } from "./payments/nwcClient.js"; import { prepareStaticModal, @@ -110,11 +113,13 @@ function decorateChannelVideo(video, app = getApp()) { return null; } + let decoratedVideo = video; + if (typeof app?.decorateVideoModeration === "function") { try { const decorated = app.decorateVideoModeration(video); if (decorated && typeof decorated === "object") { - return decorated; + decoratedVideo = decorated; } } catch (error) { devLogger.warn( @@ -124,7 +129,21 @@ function decorateChannelVideo(video, app = getApp()) { } } - return video; + if (typeof app?.decorateVideoCreatorIdentity === "function") { + try { + const identityDecorated = app.decorateVideoCreatorIdentity(decoratedVideo); + if (identityDecorated && typeof identityDecorated === "object") { + decoratedVideo = identityDecorated; + } + } catch (error) { + devLogger.warn( + "[ChannelProfile] Failed to decorate channel video identity", + error, + ); + } + } + + return decoratedVideo; } function collectChannelVideos(pubkey, app = getApp()) { @@ -2553,15 +2572,33 @@ function createZapDependencies({ } return payment; } catch (error) { + const allowanceExhausted = isZapAllowanceExhaustedError(error); + if (allowanceExhausted) { + error.__zapAllowanceExhausted = true; + } if (Array.isArray(shareTracker)) { shareTracker.push({ type: shareType, status: "error", amount: shareAmount, address, - error + error, + allowanceExhausted }); } + if ( + typeof error?.message === "string" && + error.message.toLowerCase().includes("timed out") + ) { + try { + resetWalletClient(); + } catch (resetError) { + devLogger?.warn?.( + "[zap] Failed to reset wallet client after timeout", + resetError + ); + } + } logZapError( "wallet.sendPayment", { @@ -2928,6 +2965,83 @@ async function handleZapSend(event) { const { context, result } = attempt; const receipts = Array.isArray(result?.receipts) ? result.receipts : []; + + const failureReceipts = receipts.filter((receipt) => { + if (!receipt || typeof receipt !== "object") { + return false; + } + if (typeof receipt.status === "string" && receipt.status !== "success") { + return true; + } + return Boolean(receipt.error); + }); + + if (failureReceipts.length) { + renderZapReceipts(receipts, { partial: true }); + + const failureShares = failureReceipts + .map((receipt) => { + const amount = Math.max(0, Math.round(Number(receipt.amount) || 0)); + return { + type: receipt.recipientType || receipt.type || "creator", + amount, + address: + typeof receipt.address === "string" && receipt.address + ? receipt.address + : undefined, + error: receipt.error + }; + }) + .filter((share) => share.amount > 0); + + if (failureShares.length) { + markZapRetryPending(failureShares); + } + + const shareSummary = failureShares + .map((share) => `${describeShareType(share.type)} ${share.amount} sats`) + .join(", "); + + const failureMessage = failureReceipts + .map((receipt) => { + if (typeof receipt?.error?.message === "string") { + return receipt.error.message; + } + if (typeof receipt?.error === "string") { + return receipt.error; + } + return ""; + }) + .find((message) => message); + + const budgetReceipt = failureReceipts.find((receipt) => + isZapAllowanceExhaustedError(receipt?.error) + ); + const isBudgetExceeded = + Boolean(budgetReceipt) || + (typeof failureMessage === "string" && /budget exceeded/i.test(failureMessage)); + + let warningMessage; + if (isBudgetExceeded) { + warningMessage = + "Budget exceeded. Increase your wallet zap limit or reduce the platform fee, then retry the remaining shares."; + } else if (failureMessage) { + warningMessage = failureMessage; + } else { + warningMessage = + "Some zap shares failed. Press Send again to retry the remaining shares."; + } + + if (shareSummary) { + const normalized = warningMessage.replace(/\.*$/, ""); + warningMessage = `${normalized}. Remaining share(s): ${shareSummary}.`; + } + + setZapStatus(warningMessage, "warning"); + app?.showError?.(warningMessage); + return; + } + renderZapReceipts(receipts, { partial: false }); const creatorShare = context.shares.creatorShare; @@ -2963,23 +3077,54 @@ async function handleZapSend(event) { const failureShares = tracker.filter( (entry) => entry && entry.status !== "success" && entry.amount > 0 ); + const allowanceExhausted = + isZapAllowanceExhaustedError(error) || + failureShares.some((share) => + isZapAllowanceExhaustedError(share?.error) + ); + if (allowanceExhausted) { + resetZapRetryState(); + } + if (failureShares.length) { - markZapRetryPending(failureShares); - const summary = failureShares - .map((share) => `${describeShareType(share.type)} ${share.amount} sats`) - .join(", "); - const tone = tracker.length > failureShares.length ? "warning" : "error"; - const statusMessage = - tracker.length > failureShares.length - ? `Partial zap failure. Press Send again to retry: ${summary}.` - : `Zap failed. Press Send again to retry: ${summary}.`; - setZapStatus(statusMessage, tone); - app?.showError?.(error?.message || statusMessage); + if (allowanceExhausted) { + const allowanceShare = failureShares.find((share) => + isZapAllowanceExhaustedError(share?.error) + ); + const allowanceMessage = buildZapAllowanceExhaustedMessage( + isZapAllowanceExhaustedError(error) ? error : allowanceShare?.error + ); + const partialSuccess = tracker.length > failureShares.length; + const tone = partialSuccess ? "warning" : "error"; + const statusMessage = partialSuccess + ? `Some zap shares succeeded before your wallet allowance was exhausted. ${allowanceMessage}` + : allowanceMessage; + setZapStatus(statusMessage, tone); + app?.showError?.(statusMessage); + } else { + markZapRetryPending(failureShares); + const summary = failureShares + .map((share) => `${describeShareType(share.type)} ${share.amount} sats`) + .join(", "); + const tone = tracker.length > failureShares.length ? "warning" : "error"; + const statusMessage = + tracker.length > failureShares.length + ? `Partial zap failure. Press Send again to retry: ${summary}.` + : `Zap failed. Press Send again to retry: ${summary}.`; + setZapStatus(statusMessage, tone); + app?.showError?.(error?.message || statusMessage); + } } else { resetZapRetryState(); - const message = error?.message || "Zap failed. Please try again."; - setZapStatus(message, "error"); - app?.showError?.(message); + if (allowanceExhausted) { + const allowanceMessage = buildZapAllowanceExhaustedMessage(error); + setZapStatus(allowanceMessage, "error"); + app?.showError?.(allowanceMessage); + } else { + const message = error?.message || "Zap failed. Please try again."; + setZapStatus(message, "error"); + app?.showError?.(message); + } } } finally { zapInFlight = false; @@ -4357,6 +4502,34 @@ export async function renderChannelVideosFromList({ cardState = "critical"; } + const identity = { + name: + typeof video.creatorName === "string" && video.creatorName + ? video.creatorName + : typeof video.authorName === "string" + ? video.authorName + : "", + picture: + typeof video.creatorPicture === "string" && video.creatorPicture + ? video.creatorPicture + : typeof video.authorPicture === "string" + ? video.authorPicture + : "", + pubkey: typeof video.pubkey === "string" ? video.pubkey : "", + npub: + typeof video.npub === "string" && video.npub + ? video.npub + : typeof video.authorNpub === "string" + ? video.authorNpub + : "", + shortNpub: + typeof video.shortNpub === "string" && video.shortNpub + ? video.shortNpub + : typeof video.creatorNpub === "string" + ? video.creatorNpub + : "", + }; + const videoCard = new VideoCard({ document, video, @@ -4365,6 +4538,7 @@ export async function renderChannelVideosFromList({ pointerInfo, timeAgo, cardState, + identity, capabilities: { canEdit, canDelete: canEdit, @@ -4386,7 +4560,7 @@ export async function renderChannelVideosFromList({ typeof value === "number" ? value.toLocaleString() : value }, assets: { - fallbackThumbnailSrc: "assets/jpg/video-thumbnail-fallback.jpg", + fallbackThumbnailSrc: "/assets/jpg/video-thumbnail-fallback.jpg", unsupportedBtihMessage }, state: { loadedThumbnails }, diff --git a/js/config.js b/js/config.js index 7a07c770..32c5c207 100644 --- a/js/config.js +++ b/js/config.js @@ -3,6 +3,7 @@ import { userLogger } from "./utils/logger.js"; import { IS_DEV_MODE, + IS_VERBOSE_DEV_MODE, IS_LOCKDOWN_MODE, ADMIN_SUPER_NPUB, ADMIN_DM_IMAGE_URL, @@ -13,6 +14,7 @@ import { GITHUB_URL, BETA_URL, DNS_URL, + TIP_JAR_URL, MAX_WALLET_DEFAULT_ZAP, PLATFORM_FEE_PERCENT, PLATFORM_LUD16_OVERRIDE, @@ -43,11 +45,15 @@ import { export const isDevMode = Boolean(IS_DEV_MODE); export { IS_DEV_MODE }; +export const isVerboseDevMode = Boolean(IS_VERBOSE_DEV_MODE); +export { IS_VERBOSE_DEV_MODE }; + export const isLockdownMode = Boolean(IS_LOCKDOWN_MODE); export { IS_LOCKDOWN_MODE }; if (typeof window !== "undefined") { window.__BITVID_DEV_MODE__ = isDevMode; + window.__BITVID_VERBOSE_DEV_MODE__ = isVerboseDevMode; window.__BITVID_LOCKDOWN_MODE__ = isLockdownMode; } @@ -65,6 +71,7 @@ export { NOSTR_URL }; export { GITHUB_URL }; export { BETA_URL }; export { DNS_URL }; +export { TIP_JAR_URL }; export { MAX_WALLET_DEFAULT_ZAP }; export { PLATFORM_FEE_PERCENT }; export { PLATFORM_LUD16_OVERRIDE }; diff --git a/js/constants.js b/js/constants.js index 5610718b..39d2b5ea 100644 --- a/js/constants.js +++ b/js/constants.js @@ -106,9 +106,11 @@ function sanitizeTrustSeedList(candidate) { const DEFAULT_WSS_TRACKERS = Object.freeze([ "wss://tracker.openwebtorrent.com", - "wss://tracker.fastcast.nz", - "wss://tracker.webtorrent.dev", - "wss://tracker.sloppyta.co:443/announce", + "wss://tracker.ghostchu-services.top:443/announce", + "wss://tracker.files.fm:7073/announce", + "wss://tracker.dler.org:443/announce", + "wss://tracker.btorrent.xyz", + "wss://tracker.novage.com.ua:443/announce", ]); const SANITIZED_DEFAULT_BLUR_THRESHOLD = coerceNonNegativeInteger( @@ -150,6 +152,7 @@ const DEFAULT_FLAGS = Object.freeze({ FEATURE_HASHTAG_PREFERENCES: false, FEATURE_TRUST_SEEDS: true, // Rollback: disable to drop baseline trust seeds without code changes. FEATURE_TRUSTED_HIDE_CONTROLS: true, + FEATURE_IMPROVED_COMMENT_FETCHING: true, // Default true for comment persistence fixes TRUSTED_MUTE_HIDE_THRESHOLD: DEFAULT_TRUSTED_MUTE_HIDE_THRESHOLD, TRUSTED_SPAM_HIDE_THRESHOLD: DEFAULT_TRUSTED_SPAM_HIDE_THRESHOLD, WSS_TRACKERS: DEFAULT_WSS_TRACKERS, @@ -171,6 +174,8 @@ const runtimeFlags = (() => { FEATURE_HASHTAG_PREFERENCES: DEFAULT_FLAGS.FEATURE_HASHTAG_PREFERENCES, FEATURE_TRUST_SEEDS: DEFAULT_FLAGS.FEATURE_TRUST_SEEDS, FEATURE_TRUSTED_HIDE_CONTROLS: DEFAULT_FLAGS.FEATURE_TRUSTED_HIDE_CONTROLS, + FEATURE_IMPROVED_COMMENT_FETCHING: + DEFAULT_FLAGS.FEATURE_IMPROVED_COMMENT_FETCHING, TRUSTED_MUTE_HIDE_THRESHOLD: DEFAULT_FLAGS.TRUSTED_MUTE_HIDE_THRESHOLD, TRUSTED_SPAM_HIDE_THRESHOLD: DEFAULT_FLAGS.TRUSTED_SPAM_HIDE_THRESHOLD, WSS_TRACKERS: [...DEFAULT_FLAGS.WSS_TRACKERS], @@ -221,6 +226,11 @@ export let FEATURE_TRUSTED_HIDE_CONTROLS = coerceBoolean( DEFAULT_FLAGS.FEATURE_TRUSTED_HIDE_CONTROLS ); +export let FEATURE_IMPROVED_COMMENT_FETCHING = coerceBoolean( + runtimeFlags.FEATURE_IMPROVED_COMMENT_FETCHING, + DEFAULT_FLAGS.FEATURE_IMPROVED_COMMENT_FETCHING +); + export let WSS_TRACKERS = freezeTrackers( sanitizeTrackerList(runtimeFlags.WSS_TRACKERS, DEFAULT_FLAGS.WSS_TRACKERS) ); @@ -341,6 +351,20 @@ Object.defineProperty(runtimeFlags, "FEATURE_TRUSTED_HIDE_CONTROLS", { }, }); +Object.defineProperty(runtimeFlags, "FEATURE_IMPROVED_COMMENT_FETCHING", { + configurable: true, + enumerable: true, + get() { + return FEATURE_IMPROVED_COMMENT_FETCHING; + }, + set(next) { + FEATURE_IMPROVED_COMMENT_FETCHING = coerceBoolean( + next, + DEFAULT_FLAGS.FEATURE_IMPROVED_COMMENT_FETCHING + ); + }, +}); + Object.defineProperty(runtimeFlags, "WSS_TRACKERS", { configurable: true, enumerable: true, @@ -391,6 +415,8 @@ runtimeFlags.FEATURE_PUBLISH_NIP71 = FEATURE_PUBLISH_NIP71; runtimeFlags.FEATURE_HASHTAG_PREFERENCES = FEATURE_HASHTAG_PREFERENCES; runtimeFlags.FEATURE_TRUST_SEEDS = FEATURE_TRUST_SEEDS; runtimeFlags.FEATURE_TRUSTED_HIDE_CONTROLS = FEATURE_TRUSTED_HIDE_CONTROLS; +runtimeFlags.FEATURE_IMPROVED_COMMENT_FETCHING = + FEATURE_IMPROVED_COMMENT_FETCHING; runtimeFlags.WSS_TRACKERS = WSS_TRACKERS; runtimeFlags.TRUSTED_MUTE_HIDE_THRESHOLD = TRUSTED_MUTE_HIDE_THRESHOLD; runtimeFlags.TRUSTED_SPAM_HIDE_THRESHOLD = TRUSTED_SPAM_HIDE_THRESHOLD; @@ -429,6 +455,11 @@ export function setTrustedHideControlsEnabled(next) { return FEATURE_TRUSTED_HIDE_CONTROLS; } +export function setImprovedCommentFetchingEnabled(next) { + runtimeFlags.FEATURE_IMPROVED_COMMENT_FETCHING = next; + return FEATURE_IMPROVED_COMMENT_FETCHING; +} + export function setHashtagPreferencesEnabled(next) { runtimeFlags.FEATURE_HASHTAG_PREFERENCES = next; return FEATURE_HASHTAG_PREFERENCES; @@ -444,6 +475,9 @@ export function resetRuntimeFlags() { setHashtagPreferencesEnabled(DEFAULT_FLAGS.FEATURE_HASHTAG_PREFERENCES); setTrustSeedsEnabled(DEFAULT_FLAGS.FEATURE_TRUST_SEEDS); setTrustedHideControlsEnabled(DEFAULT_FLAGS.FEATURE_TRUSTED_HIDE_CONTROLS); + setImprovedCommentFetchingEnabled( + DEFAULT_FLAGS.FEATURE_IMPROVED_COMMENT_FETCHING + ); setTrustedMuteHideThreshold(DEFAULT_FLAGS.TRUSTED_MUTE_HIDE_THRESHOLD); setTrustedSpamHideThreshold(DEFAULT_FLAGS.TRUSTED_SPAM_HIDE_THRESHOLD); setWssTrackers(DEFAULT_FLAGS.WSS_TRACKERS); diff --git a/js/index.js b/js/index.js index c9d5f167..e2189682 100644 --- a/js/index.js +++ b/js/index.js @@ -26,6 +26,7 @@ import { GITHUB_URL, BETA_URL, DNS_URL, + TIP_JAR_URL, isLockdownMode, } from "./config.js"; import AuthService from "./services/authService.js"; @@ -664,6 +665,12 @@ async function bootstrapInterface() { label: "Sidebar DNS link", }); + bindOptionalExternalLink({ + selector: "[data-tip-jar-link]", + url: TIP_JAR_URL, + label: "Sidebar Tip Jar link", + }); + const headerSearchForm = document.getElementById("headerSearchForm"); if (headerSearchForm) { headerSearchForm.addEventListener("submit", async (event) => { diff --git a/js/nostr/client.js b/js/nostr/client.js index 27249fc3..8289536d 100644 --- a/js/nostr/client.js +++ b/js/nostr/client.js @@ -3,6 +3,7 @@ import { isDevMode } from "../config.js"; import { FEATURE_PUBLISH_NIP71 } from "../constants.js"; import { accessControl } from "../accessControl.js"; +import { bytesToHex, sha256 } from "../../vendor/crypto-helpers.bundle.min.js"; // 🔧 merged conflicting changes from codex/update-video-publishing-and-parsing-logic vs unstable import { buildNip71MetadataTags, @@ -38,7 +39,6 @@ import { } from "./watchHistory.js"; import { buildVideoPostEvent, - buildVideoMirrorEvent, buildRepostEvent, buildWatchHistoryIndexEvent, buildWatchHistoryChunkEvent, @@ -58,6 +58,11 @@ import { listVideoComments as listVideoCommentsForClient, subscribeVideoComments as subscribeVideoCommentsForClient, } from "./commentEvents.js"; +import { + logCountTimeoutCleanupFailure, + logRelayCountFailure, +} from "./countDiagnostics.js"; +import "./maxListenerDiagnostics.js"; import { publishEventToRelay, publishEventToRelays, @@ -345,7 +350,7 @@ function withRequestTimeout(promise, timeoutMs, onTimeout, message = "Request ti try { onTimeout(); } catch (cleanupError) { - devLogger.warn("[nostr] COUNT timeout cleanup failed:", cleanupError); + logCountTimeoutCleanupFailure(cleanupError); } } reject(new Error(message)); @@ -408,6 +413,85 @@ function extractVideoPublishPayload(rawPayload) { return { videoData: normalizedVideoData, nip71Metadata }; } +function normalizeHexHash(candidate) { + if (candidate === undefined || candidate === null) { + return ""; + } + const stringValue = + typeof candidate === "string" ? candidate : String(candidate); + const trimmed = stringValue.trim().toLowerCase(); + if (!trimmed) { + return ""; + } + return HEX64_REGEX.test(trimmed) ? trimmed : ""; +} + +const BlobConstructor = typeof Blob !== "undefined" ? Blob : null; +let sharedTextEncoder = null; + +function getSharedTextEncoder() { + if (!sharedTextEncoder && typeof TextEncoder !== "undefined") { + sharedTextEncoder = new TextEncoder(); + } + return sharedTextEncoder; +} + +async function valueToUint8Array(value) { + if (!value) { + return null; + } + + try { + if ( + BlobConstructor && + value instanceof BlobConstructor && + typeof value.arrayBuffer === "function" + ) { + const buffer = await value.arrayBuffer(); + return new Uint8Array(buffer); + } + } catch (error) { + devLogger.warn("[nostr] Failed to read Blob while computing hash:", error); + return null; + } + + if (typeof ArrayBuffer !== "undefined") { + if (value instanceof ArrayBuffer) { + return new Uint8Array(value); + } + if (ArrayBuffer.isView?.(value)) { + return new Uint8Array(value.buffer, value.byteOffset, value.byteLength); + } + } + + if (typeof Buffer !== "undefined" && Buffer.isBuffer?.(value)) { + return new Uint8Array(value.buffer, value.byteOffset, value.byteLength); + } + + if (typeof value === "string") { + const encoder = getSharedTextEncoder(); + return encoder ? encoder.encode(value) : null; + } + + return null; +} + +async function computeSha256HexFromValue(value) { + const data = await valueToUint8Array(value); + if (!data) { + return ""; + } + + try { + const digest = sha256(data); + const hex = typeof digest === "string" ? digest : bytesToHex(digest); + return hex ? hex.toLowerCase() : ""; + } catch (error) { + devLogger.warn("[nostr] Failed to compute SHA-256 for mirror payload:", error); + return ""; + } +} + function eventToAddressPointer(event) { if (!event || typeof event !== "object") { return ""; @@ -689,23 +773,30 @@ function buildDmFilters(actorPubkey, { since, until, limit } = {}) { } -const EXTENSION_MIME_MAP = { - mp4: "video/mp4", - m4v: "video/x-m4v", - webm: "video/webm", - mkv: "video/x-matroska", - mov: "video/quicktime", - avi: "video/x-msvideo", - ogv: "video/ogg", - ogg: "video/ogg", - m3u8: "application/x-mpegURL", - mpd: "application/dash+xml", - ts: "video/mp2t", - mpg: "video/mpeg", - mpeg: "video/mpeg", - flv: "video/x-flv", - "3gp": "video/3gpp", -}; +const EXTENSION_MIME_MAP = Object.freeze( + Object.fromEntries( + Object.entries({ + mp4: "video/mp4", + m4v: "video/x-m4v", + webm: "video/webm", + mkv: "video/x-matroska", + mov: "video/quicktime", + avi: "video/x-msvideo", + ogv: "video/ogg", + ogg: "video/ogg", + m3u8: "application/x-mpegurl", + mpd: "application/dash+xml", + ts: "video/mp2t", + mpg: "video/mpeg", + mpeg: "video/mpeg", + flv: "video/x-flv", + "3gp": "video/3gpp", + }).map(([extension, mimeType]) => [ + extension, + typeof mimeType === "string" ? mimeType.toLowerCase() : "", + ]), + ), +); function inferMimeTypeFromUrl(url) { if (!url || typeof url !== "string") { @@ -728,7 +819,8 @@ function inferMimeTypeFromUrl(url) { } const extension = match[1].toLowerCase(); - return EXTENSION_MIME_MAP[extension] || ""; + const mimeType = EXTENSION_MIME_MAP[extension]; + return typeof mimeType === "string" ? mimeType : ""; } function getActiveKey(video) { @@ -2204,6 +2296,44 @@ export class NostrClient { return resolveActiveSigner(normalizedPubkey || extensionPubkey); } + resolveEventDTag(event, fallbackEvent = null) { + const immediate = getDTagValueFromTags(event?.tags); + if (immediate) { + return immediate; + } + + const fallbackTag = getDTagValueFromTags(fallbackEvent?.tags); + if (fallbackTag) { + return fallbackTag; + } + + const candidateIds = []; + const pushCandidate = (candidate) => { + if (typeof candidate === "string" && candidate.trim()) { + const normalized = candidate.trim(); + if (!candidateIds.includes(normalized)) { + candidateIds.push(normalized); + } + } + }; + + pushCandidate(event?.id); + pushCandidate(fallbackEvent?.id); + + for (const candidateId of candidateIds) { + const rawEvent = this.rawEvents?.get?.(candidateId); + if (!rawEvent) { + continue; + } + const rawTag = getDTagValueFromTags(rawEvent.tags); + if (rawTag) { + return rawTag; + } + } + + return ""; + } + applyRootCreatedAt(video) { if (!video || typeof video !== "object") { return null; @@ -3597,8 +3727,6 @@ export class NostrClient { const subscription = this.pool.sub(relaysToUse, filters); const seenIds = new Set(); - const contextPromise = this.buildDmDecryptContext(actorPubkeyInput); - subscription.on("event", (event) => { if (!event || typeof event !== "object") { return; @@ -3624,9 +3752,14 @@ export class NostrClient { return; } - contextPromise - .then((context) => { + (async () => { + try { + const contextPromise = this.getCurrentDmDecryptContextPromise(actorPubkeyInput); + const context = await contextPromise; + if (!context.decryptors.length) { + this.refreshDmDecryptContext(actorPubkeyInput); + if (typeof options.onFailure === "function") { options.onFailure( { ok: false, event }, @@ -3636,39 +3769,31 @@ export class NostrClient { return; } - return this.decryptDirectMessageEvent(event, { + const result = await this.decryptDirectMessageEvent(event, { actorPubkey: context.actorPubkey || actorPubkeyInput, - }) - .then((result) => { - if (result?.ok) { - if (typeof options.onMessage === "function") { - options.onMessage(result, { event }); - } - } else if (typeof options.onFailure === "function") { - options.onFailure(result, { event }); - } - }) - .catch((error) => { - if (typeof options.onError === "function") { - options.onError(error, { event }); - } else { - devLogger.warn( - "[nostr] Failed to decrypt DM event from subscription.", - { - error, - id: eventId, - }, - ); - } - }); - }) - .catch((error) => { + }); + + if (result?.ok) { + if (typeof options.onMessage === "function") { + options.onMessage(result, { event }); + } + } else if (typeof options.onFailure === "function") { + options.onFailure(result, { event }); + } + } catch (error) { if (typeof options.onError === "function") { options.onError(error, { event }); } else { - devLogger.warn("[nostr] Failed to prepare DM decrypt context.", error); + devLogger.warn( + "[nostr] Failed to decrypt DM event from subscription.", + { + error, + id: eventId, + }, + ); } - }); + } + })(); }); if (typeof options.onEose === "function") { @@ -3694,6 +3819,41 @@ export class NostrClient { return subscription; } + getCurrentDmDecryptContextPromise(actorPubkeyInput = null) { + const normalizedActor = normalizeActorKey(actorPubkeyInput); + const cacheKey = normalizedActor || 'default'; + + if (!this.dmDecryptContextCache) { + this.dmDecryptContextCache = new Map(); + } + + let promise = this.dmDecryptContextCache.get(cacheKey); + if (!promise) { + promise = this.buildDmDecryptContext(actorPubkeyInput); + this.dmDecryptContextCache.set(cacheKey, promise); + } + + return promise; + } + + refreshDmDecryptContext(actorPubkeyInput = null) { + const normalizedActor = normalizeActorKey(actorPubkeyInput); + const cacheKey = normalizedActor || 'default'; + + if (!this.dmDecryptContextCache) { + this.dmDecryptContextCache = new Map(); + } + + if (this.dmDecryptContextCache.has(cacheKey)) { + this.dmDecryptContextCache.delete(cacheKey); + } + + const newPromise = this.buildDmDecryptContext(actorPubkeyInput); + this.dmDecryptContextCache.set(cacheKey, newPromise); + + return newPromise; + } + async sendDirectMessage(targetNpub, message, actorPubkeyOverride = null) { const trimmedTarget = typeof targetNpub === "string" ? targetNpub.trim() : ""; const trimmedMessage = typeof message === "string" ? message.trim() : ""; @@ -3927,7 +4087,7 @@ export class NostrClient { typeof videoData.title === "string" ? videoData.title.trim() : ""; const providedMimeType = typeof videoData.mimeType === "string" - ? videoData.mimeType.trim() + ? videoData.mimeType.trim().toLowerCase() : ""; const createdAt = Math.floor(Date.now() / 1000); @@ -3995,52 +4155,111 @@ export class NostrClient { if (finalUrl) { const inferredMimeType = inferMimeTypeFromUrl(finalUrl); - const mimeType = - providedMimeType || inferredMimeType || "application/octet-stream"; + const mimeTypeSource = + providedMimeType || + inferredMimeType || + "application/octet-stream"; + const mimeType = mimeTypeSource.toLowerCase(); - const mirrorTags = [ - ["url", finalUrl], - ["m", mimeType], + const fileHashCandidates = [ + videoData.fileSha256, + videoData.uploadedFileSha256, + videoPayload?.legacyFormData?.fileSha256, + videoPayload?.fileSha256, ]; - - if (finalThumbnail) { - mirrorTags.push(["thumb", finalThumbnail]); + let fileSha256 = ""; + for (const candidate of fileHashCandidates) { + const normalized = normalizeHexHash(candidate); + if (normalized) { + fileSha256 = normalized; + break; + } } - const altText = finalDescription || finalTitle || ""; - if (altText) { - mirrorTags.push(["alt", altText]); + const originalHashCandidates = [ + videoData.originalFileSha256, + videoPayload?.legacyFormData?.originalFileSha256, + videoPayload?.originalFileSha256, + ]; + let originalFileSha256 = ""; + for (const candidate of originalHashCandidates) { + const normalized = normalizeHexHash(candidate); + if (normalized) { + originalFileSha256 = normalized; + break; + } } - if (!contentObject.isPrivate && finalMagnet) { - mirrorTags.push(["magnet", finalMagnet]); + const uploadedFile = + videoData?.uploadedFile || + videoData?.file || + videoPayload?.legacyFormData?.uploadedFile || + videoPayload?.legacyFormData?.file || + videoPayload?.uploadedFile || + videoPayload?.file || + null; + + const originalFile = + videoData?.originalFile || + videoPayload?.legacyFormData?.originalFile || + videoPayload?.originalFile || + uploadedFile; + + if (!fileSha256 && uploadedFile) { + fileSha256 = await computeSha256HexFromValue(uploadedFile); } - const mirrorEvent = buildVideoMirrorEvent({ - pubkey: normalizedPubkey, + if (!originalFileSha256 && originalFile) { + originalFileSha256 = await computeSha256HexFromValue(originalFile); + } + + if (!originalFileSha256 && fileSha256) { + originalFileSha256 = fileSha256; + } + + const mirrorOptions = { + url: finalUrl, + magnet: finalMagnet, + thumbnail: finalThumbnail, + description: finalDescription, + title: finalTitle, + mimeType, + isPrivate: contentObject.isPrivate, + actorPubkey: normalizedPubkey, created_at: createdAt, - tags: mirrorTags, - content: altText, - }); + }; - devLogger.log("Prepared NIP-94 mirror event:", mirrorEvent); + if (fileSha256) { + mirrorOptions.fileSha256 = fileSha256; + } + + if (originalFileSha256) { + mirrorOptions.originalFileSha256 = originalFileSha256; + } try { - await this.signAndPublishEvent(mirrorEvent, { - context: "NIP-94 mirror", - logName: "NIP-94 mirror", - devLogLabel: "NIP-94 mirror", - rejectionLogLevel: "warn", - }); - - devLogger.log( - "NIP-94 mirror dispatched for hosted URL:", - finalUrl + const mirrorResult = await this.mirrorVideoEvent( + signedEvent.id, + mirrorOptions, ); + + if (mirrorResult?.ok) { + devLogger.log("Prepared NIP-94 mirror event:", mirrorResult.event); + devLogger.log( + "NIP-94 mirror dispatched for hosted URL:", + finalUrl, + ); + } else if (mirrorResult) { + devLogger.warn( + "[nostr] NIP-94 mirror rejected:", + mirrorResult.error || "mirror-failed", + mirrorResult.details || null, + ); + } } catch (mirrorError) { devLogger.warn( - "[nostr] NIP-94 mirror rejected by all relays:", - mirrorError + "[nostr] Failed to publish NIP-94 mirror:", + mirrorError, ); } } else devLogger.log("Skipping NIP-94 mirror: no hosted URL provided."); @@ -4175,8 +4394,9 @@ export class NostrClient { } /** - * Edits a video by creating a *new event* with a brand-new d tag, - * but reuses the same videoRootId as the original. + * Edits a video by creating a new event that reuses the existing d tag + * so subsequent publishes overwrite the same NIP-33 addressable record + * while keeping the original videoRootId. * * This version forces version=2 for the original note and uses * lowercase comparison for public keys. @@ -4267,8 +4487,17 @@ export class NostrClient { // Use the existing videoRootId (or fall back to the base event's ID) const oldRootId = baseEvent.videoRootId || baseEvent.id; - // Generate a new d-tag so that the edit gets its own share link - const newD = `${Date.now()}-edit-${Math.random().toString(36).slice(2)}`; + const preservedDTag = this.resolveEventDTag(baseEvent, originalEventStub); + const fallbackDTag = + (typeof baseEvent.id === "string" && baseEvent.id.trim()) || + (typeof originalEventStub?.id === "string" && originalEventStub.id.trim()) || + ""; + const finalDTagValue = + (typeof preservedDTag === "string" && preservedDTag.trim()) || fallbackDTag; + + if (!finalDTagValue) { + throw new Error("Unable to determine a stable d tag for this edit."); + } // Build the updated content object const contentObject = { @@ -4313,13 +4542,13 @@ export class NostrClient { const event = buildVideoPostEvent({ pubkey: userPubkeyLower, created_at: Math.floor(Date.now() / 1000), - dTagValue: newD, + dTagValue: finalDTagValue, content: contentObject, additionalTags: nip71Tags, }); devLogger.log("Creating edited event with root ID:", oldRootId); - devLogger.log("Event content:", event.content); + devLogger.log("Event content:", event.content); await this.ensureActiveSignerForPubkey(userPubkeyLower); @@ -4442,9 +4671,9 @@ export class NostrClient { }; } - const safeTags = Array.isArray(baseEvent.tags) ? baseEvent.tags : []; - const dTag = safeTags.find((t) => t[0] === "d"); - const existingD = dTag ? dTag[1] : null; + const existingD = this.resolveEventDTag(baseEvent, originalEvent) || null; + const stableDTag = + existingD || baseEvent?.id || originalEvent?.id || null; let oldContent = {}; try { @@ -4459,7 +4688,7 @@ export class NostrClient { oldContent.videoRootId || (existingD ? `LEGACY:${baseEvent.pubkey}:${existingD}` - : baseEvent.id); + : stableDTag || baseEvent?.id || originalEvent?.id || ""); const oldIsNsfw = oldContent.isNsfw === true; const oldIsForKids = oldContent.isForKids === true && !oldIsNsfw; @@ -4480,8 +4709,11 @@ export class NostrClient { }; const tags = [["t", "video"]]; - if (existingD) { - tags.push(["d", existingD]); + if (stableDTag) { + // NIP-78 requires replaceable events to publish a stable "d" tag. + // Legacy videos may not carry one, so reuse the prior event id to + // guarantee the revert stays addressable. + tags.push(["d", stableDTag]); } const event = { @@ -4610,7 +4842,7 @@ export class NostrClient { (targetVideo && typeof targetVideo.videoRootId === "string" ? targetVideo.videoRootId.trim() : ""); - const targetDTag = targetVideo ? getDTagValueFromTags(targetVideo.tags) : ""; + const targetDTag = this.resolveEventDTag(targetVideo); if (targetVideo) { try { @@ -4640,7 +4872,7 @@ export class NostrClient { const candidateRoot = typeof candidate.videoRootId === "string" ? candidate.videoRootId : ""; - const candidateDTag = getDTagValueFromTags(candidate.tags); + const candidateDTag = this.resolveEventDTag(candidate); const sameRoot = inferredRoot && candidateRoot === inferredRoot; const sameD = targetDTag && candidateDTag === targetDTag; const legacyMatch = @@ -5739,18 +5971,15 @@ export class NostrClient { }); const count = this.extractCountValue(frame?.[2]); return { url, ok: true, frame, count }; - } catch (error) { - const isUnsupported = error?.code === "count-unsupported"; - if (isUnsupported) { - this.countUnsupportedRelays.add(url); - } else { - devLogger.warn( - `[nostr] COUNT request failed on ${url}:`, - error, - ); - } - return { url, ok: false, error, unsupported: isUnsupported }; + } catch (error) { + const isUnsupported = error?.code === "count-unsupported"; + if (isUnsupported) { + this.countUnsupportedRelays.add(url); + } else { + logRelayCountFailure(url, error); } + return { url, ok: false, error, unsupported: isUnsupported }; + } }) ); @@ -5830,7 +6059,7 @@ export class NostrClient { const targetRoot = typeof video.videoRootId === "string" ? video.videoRootId : ""; const targetPubkey = typeof video.pubkey === "string" ? video.pubkey.toLowerCase() : ""; - const targetDTag = getDTagValueFromTags(video.tags); + const targetDTag = this.resolveEventDTag(video); const collectLocalMatches = () => { const seen = new Set(); @@ -5850,7 +6079,7 @@ export class NostrClient { const candidateRoot = typeof candidate.videoRootId === "string" ? candidate.videoRootId : ""; - const candidateDTag = getDTagValueFromTags(candidate.tags); + const candidateDTag = this.resolveEventDTag(candidate, video); const sameRoot = targetRoot && candidateRoot === targetRoot; const sameD = targetDTag && candidateDTag === targetDTag; diff --git a/js/nostr/commentEvents.js b/js/nostr/commentEvents.js index 727a46ad..b90bf7aa 100644 --- a/js/nostr/commentEvents.js +++ b/js/nostr/commentEvents.js @@ -2,17 +2,26 @@ import { buildCommentEvent, getNostrEventSchema, NOTE_TYPES, + sanitizeAdditionalTags, } from "../nostrEventSchemas.js"; import { publishEventToRelay } from "../nostrPublish.js"; import { RELAY_URLS } from "./toolkit.js"; import { normalizePointerInput } from "./watchHistory.js"; import { devLogger, userLogger } from "../utils/logger.js"; - const COMMENT_EVENT_SCHEMA = getNostrEventSchema(NOTE_TYPES.VIDEO_COMMENT); export const COMMENT_EVENT_KIND = Number.isFinite(COMMENT_EVENT_SCHEMA?.kind) ? COMMENT_EVENT_SCHEMA.kind - : 1; + : 1111; +export const LEGACY_COMMENT_KIND = 1; +const ALLOWED_COMMENT_KINDS = Object.freeze( + COMMENT_EVENT_KIND === LEGACY_COMMENT_KIND + ? [COMMENT_EVENT_KIND] + : [COMMENT_EVENT_KIND, LEGACY_COMMENT_KIND] +); +function getAllowedCommentKinds() { + return ALLOWED_COMMENT_KINDS.slice(); +} function sanitizeRelayList(primary, fallback) { if (Array.isArray(primary) && primary.length) { return primary; @@ -63,8 +72,10 @@ function normalizePointerCandidate(candidate, expectedType) { } if (Array.isArray(candidate)) { + const tagName = + typeof candidate[0] === "string" ? candidate[0].trim().toLowerCase() : ""; if ( - candidate[0] === expectedType && + tagName === expectedType && typeof candidate[1] === "string" && candidate[1].trim() ) { @@ -96,7 +107,7 @@ function normalizePointerCandidate(candidate, expectedType) { if (candidate && typeof candidate === "object") { if ( typeof candidate.type === "string" && - candidate.type === expectedType && + candidate.type.toLowerCase() === expectedType && typeof candidate.value === "string" && candidate.value.trim() ) { @@ -136,6 +147,49 @@ function normalizePointerCandidate(candidate, expectedType) { return null; } +function normalizeTagName(name) { + return typeof name === "string" ? name.trim().toLowerCase() : ""; +} + +function normalizeTagValue(value) { + if (value === null || value === undefined) { + return ""; + } + if (Number.isFinite(value)) { + return String(Math.floor(value)); + } + if (typeof value === "string") { + const trimmed = value.trim(); + return trimmed ? trimmed.toLowerCase() : ""; + } + return ""; +} + +function normalizeDescriptorString(value) { + if (value === null || value === undefined) { + return ""; + } + if (Number.isFinite(value)) { + return String(Math.floor(value)); + } + if (typeof value === "string") { + const trimmed = value.trim(); + return trimmed ? trimmed.toLowerCase() : ""; + } + if (typeof value === "object" && typeof value.value !== "undefined") { + return normalizeDescriptorString(value.value); + } + return ""; +} + +function normalizeDescriptorRelay(value) { + if (typeof value === "string") { + return value.trim(); + } + return ""; +} + + function pickString(...candidates) { for (const candidate of candidates) { if (typeof candidate === "string" && candidate.trim()) { @@ -145,6 +199,74 @@ function pickString(...candidates) { return ""; } +function pickKind(...candidates) { + for (const candidate of candidates) { + if (Number.isFinite(candidate)) { + return String(Math.floor(candidate)); + } + if (typeof candidate === "string" && candidate.trim()) { + return candidate.trim(); + } + } + return ""; +} + +function isEventCandidate(candidate) { + if (!candidate || typeof candidate !== "object") { + return false; + } + if (Array.isArray(candidate.tags)) { + return true; + } + if (typeof candidate.id === "string" && candidate.id.trim()) { + return true; + } + if (typeof candidate.pubkey === "string" && candidate.pubkey.trim()) { + return true; + } + return false; +} + +function resolveEventCandidate(...candidates) { + for (const candidate of candidates) { + if (isEventCandidate(candidate)) { + return candidate; + } + } + return null; +} + +function collectTagsFromEvent(event) { + if (!event || typeof event !== "object") { + return []; + } + const tags = Array.isArray(event.tags) ? event.tags : []; + return tags.filter((tag) => Array.isArray(tag) && tag.length >= 2); +} + +function findTagByName(tags, ...names) { + const normalizedNames = names + .flat() + .map((name) => normalizeTagName(name)) + .filter(Boolean); + if (!normalizedNames.length) { + return null; + } + for (const tag of tags) { + if (!Array.isArray(tag) || tag.length < 2) { + continue; + } + const [name] = tag; + if (typeof name !== "string") { + continue; + } + if (normalizedNames.includes(normalizeTagName(name))) { + return tag; + } + } + return null; +} + function normalizeCommentTarget(targetInput = {}, overrides = {}) { const target = targetInput && typeof targetInput === "object" ? targetInput : {}; const options = overrides && typeof overrides === "object" ? overrides : {}; @@ -165,6 +287,18 @@ function normalizeCommentTarget(targetInput = {}, overrides = {}) { normalizePointerCandidate(target.definitionPointer, "a") || normalizePointerCandidate(target.definition, "a"); + const rootDefinitionPointer = + normalizePointerCandidate(options.rootDefinitionPointer, "a") || + normalizePointerCandidate(options.rootPointer, "a") || + normalizePointerCandidate(target.rootDefinitionPointer, "a") || + normalizePointerCandidate(target.rootPointer, "a"); + + const rootEventPointer = + normalizePointerCandidate(options.rootEventPointer, "e") || + normalizePointerCandidate(options.rootPointer, "e") || + normalizePointerCandidate(target.rootEventPointer, "e") || + normalizePointerCandidate(target.rootPointer, "e"); + const parentCommentPointer = normalizePointerCandidate(options.parentCommentPointer, "e") || normalizePointerCandidate(options.parentComment, "e") || @@ -172,17 +306,41 @@ function normalizeCommentTarget(targetInput = {}, overrides = {}) { normalizePointerCandidate(target.parentComment, "e") || normalizePointerCandidate(target.parentPointer, "e"); + const videoEventObject = resolveEventCandidate( + options.videoEvent, + options.rootEvent, + target.videoEvent, + target.rootEvent, + ); + + const parentCommentEvent = resolveEventCandidate( + options.parentCommentEvent, + options.parentComment, + target.parentCommentEvent, + target.parentComment, + ); + + const rootEventTags = collectTagsFromEvent(videoEventObject); + const parentEventTags = collectTagsFromEvent(parentCommentEvent); + const combinedTags = [...parentEventTags, ...rootEventTags]; + const getTagField = (tag, index) => + Array.isArray(tag) && typeof tag[index] === "string" + ? tag[index].trim() + : ""; + const videoEventId = pickString( options.videoEventId, target.videoEventId, target.eventId, videoEventPointer?.value, + rootEventPointer?.value, ); const videoEventRelay = pickString( options.videoEventRelay, target.videoEventRelay, target.eventRelay, videoEventPointer?.relay, + rootEventPointer?.relay, ); const videoDefinitionAddress = pickString( @@ -190,12 +348,14 @@ function normalizeCommentTarget(targetInput = {}, overrides = {}) { target.videoDefinitionAddress, target.definitionAddress, videoDefinitionPointer?.value, + rootDefinitionPointer?.value, ); const videoDefinitionRelay = pickString( options.videoDefinitionRelay, target.videoDefinitionRelay, target.definitionRelay, videoDefinitionPointer?.relay, + rootDefinitionPointer?.relay, ); const parentCommentId = pickString( @@ -223,20 +383,411 @@ function normalizeCommentTarget(targetInput = {}, overrides = {}) { target.participantRelay, ); - if (!videoEventId || !videoDefinitionAddress) { + let normalizedVideoEventId = + typeof videoEventId === "string" ? videoEventId.trim() : ""; + let normalizedVideoDefinitionAddress = + typeof videoDefinitionAddress === "string" ? videoDefinitionAddress.trim() : ""; + let normalizedVideoEventRelay = + typeof videoEventRelay === "string" ? videoEventRelay.trim() : ""; + let normalizedVideoDefinitionRelay = + typeof videoDefinitionRelay === "string" ? videoDefinitionRelay.trim() : ""; + let normalizedParentCommentId = + typeof parentCommentId === "string" ? parentCommentId.trim() : ""; + let normalizedParentCommentRelay = + typeof parentCommentRelay === "string" ? parentCommentRelay.trim() : ""; + const normalizedThreadParticipantPubkey = + typeof threadParticipantPubkey === "string" ? threadParticipantPubkey.trim() : ""; + const normalizedThreadParticipantRelay = + typeof threadParticipantRelay === "string" + ? threadParticipantRelay.trim() + : ""; + + const rootIdentifier = pickString( + options.rootIdentifier, + target.rootIdentifier, + options.rootPointer, + target.rootPointer, + ); + const rootIdentifierRelay = pickString( + options.rootIdentifierRelay, + target.rootIdentifierRelay, + ); + + const parentIdentifier = pickString( + options.parentIdentifier, + target.parentIdentifier, + ); + const parentIdentifierRelay = pickString( + options.parentIdentifierRelay, + target.parentIdentifierRelay, + ); + + const normalizedRootIdentifier = + typeof rootIdentifier === "string" ? rootIdentifier.trim() : ""; + let normalizedRootIdentifierRelay = + typeof rootIdentifierRelay === "string" ? rootIdentifierRelay.trim() : ""; + const normalizedParentIdentifier = + typeof parentIdentifier === "string" ? parentIdentifier.trim() : ""; + let normalizedParentIdentifierRelay = + typeof parentIdentifierRelay === "string" + ? parentIdentifierRelay.trim() + : ""; + + let normalizedVideoKind = pickKind( + options.videoKind, + target.videoKind, + videoEventObject?.kind, + ); + + let normalizedVideoAuthorPubkey = pickString( + options.videoAuthorPubkey, + target.videoAuthorPubkey, + videoEventObject?.pubkey, + ); + + const definitionSegments = normalizedVideoDefinitionAddress + ? normalizedVideoDefinitionAddress.split(":") + : []; + const derivedDefinitionKind = definitionSegments[0] || ""; + const derivedDefinitionPubkey = definitionSegments[1] || ""; + + const rootKindCandidate = pickString( + options.rootKind, + target.rootKind, + options.videoKind, + target.videoKind, + normalizedVideoKind, + derivedDefinitionKind, + ); + let normalizedRootKind = + typeof rootKindCandidate === "string" ? rootKindCandidate.trim() : ""; + + const parentKindCandidate = pickString( + options.parentKind, + target.parentKind, + options.parentCommentKind, + target.parentCommentKind, + ); + let normalizedParentKind = + typeof parentKindCandidate === "string" ? parentKindCandidate.trim() : ""; + + let normalizedRootAuthorPubkey = pickString( + options.rootAuthorPubkey, + target.rootAuthorPubkey, + options.videoAuthorPubkey, + target.videoAuthorPubkey, + normalizedVideoAuthorPubkey, + derivedDefinitionPubkey, + ); + normalizedRootAuthorPubkey = + typeof normalizedRootAuthorPubkey === "string" + ? normalizedRootAuthorPubkey.trim() + : ""; + + let normalizedParentAuthorPubkey = pickString( + options.parentAuthorPubkey, + target.parentAuthorPubkey, + options.parentCommentPubkey, + target.parentCommentPubkey, + ); + normalizedParentAuthorPubkey = + typeof normalizedParentAuthorPubkey === "string" + ? normalizedParentAuthorPubkey.trim() + : ""; + + let normalizedRootAuthorRelay = pickString( + options.rootAuthorRelay, + target.rootAuthorRelay, + ); + normalizedRootAuthorRelay = + typeof normalizedRootAuthorRelay === "string" + ? normalizedRootAuthorRelay.trim() + : ""; + + let normalizedParentAuthorRelay = pickString( + options.parentAuthorRelay, + target.parentAuthorRelay, + ); + normalizedParentAuthorRelay = + typeof normalizedParentAuthorRelay === "string" + ? normalizedParentAuthorRelay.trim() + : ""; + + if (!normalizedRootIdentifier) { + const tag = findTagByName(combinedTags, "I"); + const value = getTagField(tag, 1); + if (value) { + normalizedRootIdentifier = value; + const relay = getTagField(tag, 2); + if (relay) { + normalizedRootIdentifierRelay = relay; + } + } + } else if (!normalizedRootIdentifierRelay) { + const tag = findTagByName(combinedTags, "I"); + const relay = getTagField(tag, 2); + if (relay) { + normalizedRootIdentifierRelay = relay; + } + } + + if (!normalizedVideoDefinitionAddress) { + const tag = findTagByName(combinedTags, "A", "a"); + const value = getTagField(tag, 1); + if (value) { + normalizedVideoDefinitionAddress = value; + const relay = getTagField(tag, 2); + if (relay) { + normalizedVideoDefinitionRelay = relay; + } + } + } else if (!normalizedVideoDefinitionRelay) { + const tag = findTagByName(combinedTags, "A", "a"); + const relay = getTagField(tag, 2); + if (relay) { + normalizedVideoDefinitionRelay = relay; + } + } + + const rootEventTag = findTagByName(combinedTags, "E"); + if (rootEventTag) { + const value = getTagField(rootEventTag, 1); + if (value && !normalizedVideoEventId) { + normalizedVideoEventId = value; + } + const relay = getTagField(rootEventTag, 2); + if (relay && !normalizedVideoEventRelay) { + normalizedVideoEventRelay = relay; + } + const authorHint = getTagField(rootEventTag, 3); + if (authorHint && !normalizedRootAuthorPubkey) { + normalizedRootAuthorPubkey = authorHint; + } + } + + if (!normalizedVideoEventId || !normalizedParentCommentId) { + const eventValues = []; + for (const tag of combinedTags) { + if (!Array.isArray(tag) || tag.length < 2) { + continue; + } + if (typeof tag[0] === "string" && tag[0].trim().toLowerCase() === "e") { + const value = getTagField(tag, 1); + if (value) { + eventValues.push({ tag, value }); + } + } + } + if (!normalizedVideoEventId && eventValues.length) { + normalizedVideoEventId = eventValues[0].value; + const relay = getTagField(eventValues[0].tag, 2); + if (relay && !normalizedVideoEventRelay) { + normalizedVideoEventRelay = relay; + } + } + if (!normalizedParentCommentId && eventValues.length) { + for (let index = eventValues.length - 1; index >= 0; index -= 1) { + const candidate = eventValues[index]; + if ( + candidate.value && + candidate.value !== normalizedVideoEventId + ) { + normalizedParentCommentId = candidate.value; + const relay = getTagField(candidate.tag, 2); + if (relay) { + normalizedParentCommentRelay = relay; + } + const authorHint = getTagField(candidate.tag, 3); + if (authorHint && !normalizedParentAuthorPubkey) { + normalizedParentAuthorPubkey = authorHint; + } + break; + } + } + } + } + + if (normalizedParentCommentId && !normalizedParentCommentRelay) { + const parentTag = parentEventTags.find( + (tag) => + Array.isArray(tag) && + tag.length >= 2 && + typeof tag[0] === "string" && + tag[0].trim().toLowerCase() === "e" && + getTagField(tag, 1) === normalizedParentCommentId, + ); + if (parentTag) { + const relay = getTagField(parentTag, 2); + if (relay) { + normalizedParentCommentRelay = relay; + } + const authorHint = getTagField(parentTag, 3); + if (authorHint && !normalizedParentAuthorPubkey) { + normalizedParentAuthorPubkey = authorHint; + } + } + } + + if (!normalizedParentIdentifierRelay) { + const tag = findTagByName(parentEventTags, "i"); + const relay = getTagField(tag, 2); + if (relay) { + normalizedParentIdentifierRelay = relay; + } + } + + if (!normalizedRootKind) { + const tag = findTagByName(combinedTags, "K"); + const value = getTagField(tag, 1); + if (value) { + normalizedRootKind = value; + } + } + if (!normalizedVideoKind && normalizedRootKind) { + normalizedVideoKind = normalizedRootKind; + } + + if (!normalizedRootAuthorPubkey || !normalizedRootAuthorRelay) { + const tag = findTagByName(combinedTags, "P"); + if (tag) { + const value = getTagField(tag, 1); + if (value && !normalizedRootAuthorPubkey) { + normalizedRootAuthorPubkey = value; + } + const relay = getTagField(tag, 2); + if (relay && !normalizedRootAuthorRelay) { + normalizedRootAuthorRelay = relay; + } + } + } + if (!normalizedVideoAuthorPubkey && normalizedRootAuthorPubkey) { + normalizedVideoAuthorPubkey = normalizedRootAuthorPubkey; + } + + if (!normalizedParentKind) { + const tag = findTagByName(parentEventTags, "k"); + const value = getTagField(tag, 1); + if (value) { + normalizedParentKind = value; + } + } + + if (!normalizedParentAuthorPubkey || !normalizedParentAuthorRelay) { + const tag = findTagByName(parentEventTags, "p"); + if (tag) { + const value = getTagField(tag, 1); + if (value && !normalizedParentAuthorPubkey) { + normalizedParentAuthorPubkey = value; + } + const relay = getTagField(tag, 2); + if (relay && !normalizedParentAuthorRelay) { + normalizedParentAuthorRelay = relay; + } + } + } + + if (!normalizedParentKind) { + if (normalizedParentCommentId) { + normalizedParentKind = String(COMMENT_EVENT_KIND); + } else if (normalizedRootKind) { + normalizedParentKind = normalizedRootKind; + } else if (derivedDefinitionKind) { + normalizedParentKind = derivedDefinitionKind; + } + } + + if (!normalizedRootKind) { + normalizedRootKind = normalizedParentKind; + } + + if (!normalizedParentAuthorPubkey) { + normalizedParentAuthorPubkey = normalizedThreadParticipantPubkey; + } + + if (!normalizedRootAuthorPubkey) { + if (!normalizedParentCommentId && normalizedParentAuthorPubkey) { + normalizedRootAuthorPubkey = normalizedParentAuthorPubkey; + } + } + + if (!normalizedRootAuthorRelay && normalizedVideoDefinitionRelay) { + normalizedRootAuthorRelay = normalizedVideoDefinitionRelay; + } + + if (!normalizedParentAuthorRelay) { + normalizedParentAuthorRelay = normalizedThreadParticipantRelay; + } + + if (!normalizedRootAuthorRelay && !normalizedParentCommentId) { + normalizedRootAuthorRelay = normalizedParentAuthorRelay; + } + + if (!normalizedRootAuthorPubkey && derivedDefinitionPubkey) { + normalizedRootAuthorPubkey = derivedDefinitionPubkey; + } + + if (!normalizedParentAuthorPubkey && !normalizedParentCommentId) { + normalizedParentAuthorPubkey = normalizedRootAuthorPubkey; + } + + if (!normalizedParentAuthorRelay && !normalizedParentCommentId) { + normalizedParentAuthorRelay = normalizedRootAuthorRelay; + } + + const descriptor = { + videoEventId: normalizeDescriptorString(normalizedVideoEventId), + videoEventRelay: normalizeDescriptorRelay(normalizedVideoEventRelay), + videoDefinitionAddress: normalizeDescriptorString(normalizedVideoDefinitionAddress), + videoDefinitionRelay: normalizeDescriptorRelay(normalizedVideoDefinitionRelay), + videoKind: normalizeDescriptorString(normalizedVideoKind), + videoAuthorPubkey: normalizeDescriptorString(normalizedVideoAuthorPubkey), + parentCommentId: normalizeDescriptorString(normalizedParentCommentId), + parentCommentRelay: normalizeDescriptorRelay(normalizedParentCommentRelay), + threadParticipantPubkey: normalizeDescriptorString(normalizedThreadParticipantPubkey), + threadParticipantRelay: normalizeDescriptorRelay(normalizedThreadParticipantRelay), + rootIdentifier: normalizeDescriptorString(normalizedRootIdentifier), + rootIdentifierRelay: normalizeDescriptorRelay(normalizedRootIdentifierRelay), + parentIdentifier: normalizeDescriptorString(normalizedParentIdentifier), + parentIdentifierRelay: normalizeDescriptorRelay(normalizedParentIdentifierRelay), + rootKind: normalizeDescriptorString(normalizedRootKind), + rootAuthorPubkey: normalizeDescriptorString(normalizedRootAuthorPubkey), + rootAuthorRelay: normalizeDescriptorRelay(normalizedRootAuthorRelay), + parentKind: normalizeDescriptorString(normalizedParentKind), + parentAuthorPubkey: normalizeDescriptorString(normalizedParentAuthorPubkey), + parentAuthorRelay: normalizeDescriptorRelay(normalizedParentAuthorRelay), + }; + + if (!descriptor.videoEventId) { return null; } - return { - videoEventId, - videoEventRelay, - videoDefinitionAddress, - videoDefinitionRelay, - parentCommentId, - parentCommentRelay, - threadParticipantPubkey, - threadParticipantRelay, - }; + return descriptor; +} + +function applyFilterOptions(filter, options = {}) { + if (!filter || typeof filter !== "object") { + return filter; + } + + const result = { ...filter }; + + if ( + typeof options.limit === "number" && + Number.isFinite(options.limit) && + options.limit > 0 + ) { + result.limit = Math.floor(options.limit); + } + + if (typeof options.since === "number" && Number.isFinite(options.since)) { + result.since = Math.floor(options.since); + } + + if (typeof options.until === "number" && Number.isFinite(options.until)) { + result.until = Math.floor(options.until); + } + + return result; } function createVideoCommentFilters(targetInput, options = {}) { @@ -245,35 +796,100 @@ function createVideoCommentFilters(targetInput, options = {}) { throw new Error("Invalid video comment target supplied."); } - const filter = { - kinds: [COMMENT_EVENT_KIND], - "#e": [descriptor.videoEventId], - "#a": [descriptor.videoDefinitionAddress], - }; + const filters = []; - if (descriptor.parentCommentId) { - if (!filter["#e"].includes(descriptor.parentCommentId)) { - filter["#e"].push(descriptor.parentCommentId); - } + const eventFilter = { + kinds: getAllowedCommentKinds(), + "#e": [descriptor.videoEventId], + }; + filters.push(applyFilterOptions(eventFilter, options)); + + const uppercaseEventFilter = { + kinds: getAllowedCommentKinds(), + "#E": [descriptor.videoEventId], + }; + filters.push(applyFilterOptions(uppercaseEventFilter, options)); + + const uppercaseFilter = { kinds: getAllowedCommentKinds() }; + let hasUppercasePointer = false; + + if (typeof descriptor.rootIdentifier === "string" && descriptor.rootIdentifier) { + uppercaseFilter["#I"] = [descriptor.rootIdentifier]; + hasUppercasePointer = true; + } else if ( + typeof descriptor.videoDefinitionAddress === "string" && + descriptor.videoDefinitionAddress + ) { + uppercaseFilter["#A"] = [descriptor.videoDefinitionAddress]; + hasUppercasePointer = true; + } else if ( + typeof descriptor.videoEventId === "string" && + descriptor.videoEventId + ) { + uppercaseFilter["#E"] = [descriptor.videoEventId]; + hasUppercasePointer = true; + } + + const normalizedRootKind = normalizeDescriptorString( + descriptor.rootKind || descriptor.videoKind, + ); + if (normalizedRootKind) { + uppercaseFilter["#K"] = [normalizedRootKind]; + } + + const normalizedRootAuthor = normalizeDescriptorString( + descriptor.rootAuthorPubkey || descriptor.videoAuthorPubkey, + ); + if (normalizedRootAuthor) { + uppercaseFilter["#P"] = [normalizedRootAuthor]; + } + + if (hasUppercasePointer) { + filters.push(applyFilterOptions(uppercaseFilter, options)); } if ( - typeof options.limit === "number" && - Number.isFinite(options.limit) && - options.limit > 0 + descriptor.parentCommentId && + descriptor.parentCommentId !== descriptor.videoEventId ) { - filter.limit = Math.floor(options.limit); + const parentFilter = { + kinds: getAllowedCommentKinds(), + "#e": [descriptor.parentCommentId], + }; + filters.push(applyFilterOptions(parentFilter, options)); + + const parentUppercaseFilter = { + kinds: getAllowedCommentKinds(), + "#E": [descriptor.parentCommentId], + }; + filters.push(applyFilterOptions(parentUppercaseFilter, options)); } - if (typeof options.since === "number" && Number.isFinite(options.since)) { - filter.since = Math.floor(options.since); + if (descriptor.videoDefinitionAddress) { + const definitionFilter = { + kinds: getAllowedCommentKinds(), + "#a": [descriptor.videoDefinitionAddress], + }; + + if (descriptor.parentCommentId) { + definitionFilter["#e"] = [descriptor.parentCommentId]; + } + + filters.push(applyFilterOptions(definitionFilter, options)); + + const definitionUppercaseFilter = { + kinds: getAllowedCommentKinds(), + "#A": [descriptor.videoDefinitionAddress], + }; + + if (descriptor.parentCommentId) { + definitionUppercaseFilter["#E"] = [descriptor.parentCommentId]; + } + + filters.push(applyFilterOptions(definitionUppercaseFilter, options)); } - if (typeof options.until === "number" && Number.isFinite(options.until)) { - filter.until = Math.floor(options.until); - } - - return { descriptor, filters: [filter] }; + return { descriptor, filters }; } function flattenListResults(input) { @@ -301,35 +917,214 @@ function isVideoCommentEvent(event, descriptor) { return false; } - if (Number(event.kind) !== COMMENT_EVENT_KIND) { + if (!getAllowedCommentKinds().includes(Number(event.kind))) { return false; } + const targetDescriptor = + descriptor && typeof descriptor === "object" ? descriptor : {}; + const tags = Array.isArray(event.tags) ? event.tags : []; - let hasEventTag = false; - let hasDefinitionTag = false; - let hasParentTag = !descriptor.parentCommentId; + const normalizedRootIdentifier = normalizeTagValue( + targetDescriptor.rootIdentifier, + ); + const normalizedVideoDefinitionAddress = normalizeTagValue( + targetDescriptor.videoDefinitionAddress, + ); + const normalizedVideoEventId = normalizeTagValue( + targetDescriptor.videoEventId, + ); + const normalizedParentCommentId = normalizeTagValue( + targetDescriptor.parentCommentId, + ); + + const requiresRootIdentifierMatch = Boolean(normalizedRootIdentifier); + const requiresAddressMatch = + !requiresRootIdentifierMatch && Boolean(normalizedVideoDefinitionAddress); + const requiresEventMatch = + !requiresRootIdentifierMatch && + !requiresAddressMatch && + Boolean(normalizedVideoEventId); + const requiresParentTag = Boolean(normalizedParentCommentId); + + let hasIdentifierTag = !requiresRootIdentifierMatch; + let hasDefinitionTag = !requiresAddressMatch; + let hasEventTag = !requiresEventMatch; + let hasParentTag = false; + + let matchedDefinitionPointer = false; + let matchedEventPointer = false; + + const expectedRootKind = normalizeDescriptorString( + targetDescriptor.rootKind || targetDescriptor.videoKind, + ); + + const expectedRootAuthor = normalizeDescriptorString( + targetDescriptor.rootAuthorPubkey || targetDescriptor.videoAuthorPubkey, + ); + + const expectedParentKind = normalizeDescriptorString(targetDescriptor.parentKind); + + const expectedParentAuthor = normalizeDescriptorString( + targetDescriptor.parentAuthorPubkey, + ); + + let sawRootKindTag = false; + let rootKindMatches = !expectedRootKind; + let rootKindMismatch = false; + + let sawRootAuthorTag = false; + let rootAuthorMatches = !expectedRootAuthor; + let rootAuthorMismatch = false; + + let sawParentKindTag = false; + let parentKindMatches = !expectedParentKind; + let parentKindMismatch = false; + + let sawParentAuthorTag = false; + let parentAuthorMatches = !expectedParentAuthor; + let parentAuthorMismatch = false; for (const tag of tags) { if (!Array.isArray(tag) || tag.length < 2) { continue; } - const [name, value] = tag; - if (name === "e" && typeof value === "string") { - if (value === descriptor.videoEventId) { - hasEventTag = true; + const [rawName, rawValue] = tag; + const trimmedName = typeof rawName === "string" ? rawName.trim() : ""; + const lowerName = trimmedName.toLowerCase(); + const normalizedValue = normalizeTagValue(rawValue); + if (!lowerName || !normalizedValue) { + continue; + } + + if (lowerName === "i") { + if ( + normalizedRootIdentifier && + normalizedValue === normalizedRootIdentifier + ) { + hasIdentifierTag = true; } - if (descriptor.parentCommentId && value === descriptor.parentCommentId) { + } else if (lowerName === "a") { + if ( + normalizedVideoDefinitionAddress && + normalizedValue === normalizedVideoDefinitionAddress + ) { + hasDefinitionTag = true; + matchedDefinitionPointer = true; + } + } else if (lowerName === "e") { + if ( + normalizedVideoEventId && + normalizedValue === normalizedVideoEventId + ) { + hasEventTag = true; + matchedEventPointer = true; + } + if ( + normalizedParentCommentId && + normalizedValue === normalizedParentCommentId + ) { hasParentTag = true; } - } else if (name === "a" && typeof value === "string") { - if (value === descriptor.videoDefinitionAddress) { - hasDefinitionTag = true; + } else if (trimmedName === "K") { + sawRootKindTag = true; + if (!expectedRootKind || normalizedValue === expectedRootKind) { + rootKindMatches = true; + } else { + rootKindMismatch = true; + } + } else if (trimmedName === "P") { + sawRootAuthorTag = true; + if (!expectedRootAuthor || normalizedValue === expectedRootAuthor) { + rootAuthorMatches = true; + } else { + rootAuthorMismatch = true; + } + } else if (trimmedName === "k") { + sawParentKindTag = true; + if (!expectedParentKind || normalizedValue === expectedParentKind) { + parentKindMatches = true; + } else { + parentKindMismatch = true; + } + } else if (trimmedName === "p") { + sawParentAuthorTag = true; + if (!expectedParentAuthor || normalizedValue === expectedParentAuthor) { + parentAuthorMatches = true; + } else { + parentAuthorMismatch = true; } } } - return hasEventTag && hasDefinitionTag && hasParentTag; + if (!hasDefinitionTag && requiresAddressMatch && matchedEventPointer) { + hasDefinitionTag = true; + } + + if (!hasIdentifierTag && requiresRootIdentifierMatch) { + if (matchedDefinitionPointer || matchedEventPointer) { + devLogger.debug( + "[nostr] Comment accepted without explicit identifier tag due to pointer match", + { + eventId: event?.id, + matchedDefinitionPointer, + matchedEventPointer, + }, + ); + hasIdentifierTag = true; + } + } + + if (!hasIdentifierTag || !hasDefinitionTag || !hasEventTag) { + if (matchedEventPointer && (!requiresParentTag || hasParentTag)) { + devLogger.debug( + "[nostr] Comment accepted via legacy pointer fallback", + { + eventId: event?.id, + hasIdentifierTag, + hasDefinitionTag, + hasEventTag, + requiresParentTag, + hasParentTag, + }, + ); + hasIdentifierTag = true; + hasDefinitionTag = true; + hasEventTag = true; + } else { + return false; + } + } + + if (requiresParentTag && !hasParentTag) { + return false; + } + + if ((sawRootKindTag && rootKindMismatch) || (sawRootAuthorTag && rootAuthorMismatch)) { + return false; + } + + if ((sawParentKindTag && parentKindMismatch) || (sawParentAuthorTag && parentAuthorMismatch)) { + return false; + } + + if (sawRootKindTag && expectedRootKind && !rootKindMatches) { + return false; + } + + if (sawRootAuthorTag && expectedRootAuthor && !rootAuthorMatches) { + return false; + } + + if (sawParentKindTag && expectedParentKind && !parentKindMatches) { + return false; + } + + if (sawParentAuthorTag && expectedParentAuthor && !parentAuthorMatches) { + return false; + } + + return true; } export async function publishComment( @@ -339,7 +1134,6 @@ export async function publishComment( { resolveActiveSigner, shouldRequestExtensionPermissions, - signEventWithPrivateKey, DEFAULT_NIP07_PERMISSION_METHODS, } = {}, ) { @@ -352,9 +1146,12 @@ export async function publishComment( return { ok: false, error: "invalid-target" }; } - const actorPubkey = await client.ensureSessionActor(); + const actorPubkey = + typeof client?.pubkey === "string" && client.pubkey.trim() + ? client.pubkey.trim() + : ""; if (!actorPubkey) { - return { ok: false, error: "missing-actor" }; + return { ok: false, error: "auth-required" }; } const createdAt = @@ -362,11 +1159,7 @@ export async function publishComment( ? Math.floor(options.created_at) : Math.floor(Date.now() / 1000); - const additionalTags = Array.isArray(options.additionalTags) - ? options.additionalTags.filter( - (tag) => Array.isArray(tag) && typeof tag[0] === "string", - ) - : []; + const additionalTags = sanitizeAdditionalTags(options.additionalTags); let content = ""; if (typeof options.content === "string") { @@ -393,81 +1186,66 @@ export async function publishComment( videoEventRelay: descriptor.videoEventRelay, videoDefinitionAddress: descriptor.videoDefinitionAddress, videoDefinitionRelay: descriptor.videoDefinitionRelay, + rootIdentifier: descriptor.rootIdentifier, + rootIdentifierRelay: descriptor.rootIdentifierRelay, parentCommentId: descriptor.parentCommentId, parentCommentRelay: descriptor.parentCommentRelay, threadParticipantPubkey: descriptor.threadParticipantPubkey, threadParticipantRelay: descriptor.threadParticipantRelay, + rootKind: descriptor.rootKind, + rootAuthorPubkey: descriptor.rootAuthorPubkey, + rootAuthorRelay: descriptor.rootAuthorRelay, + parentKind: descriptor.parentKind, + parentAuthorPubkey: descriptor.parentAuthorPubkey, + parentAuthorRelay: descriptor.parentAuthorRelay, + parentIdentifier: descriptor.parentIdentifier, + parentIdentifierRelay: descriptor.parentIdentifierRelay, additionalTags, content, }); let signedEvent = null; - const normalizedActor = - typeof actorPubkey === "string" ? actorPubkey.toLowerCase() : ""; - const normalizedLogged = - typeof client.pubkey === "string" ? client.pubkey.toLowerCase() : ""; - const resolveSignerFn = typeof resolveActiveSigner === "function" ? resolveActiveSigner : null; const signer = resolveSignerFn ? resolveSignerFn(actorPubkey) : null; - const canUseActiveSigner = - normalizedActor && - normalizedActor === normalizedLogged && - signer && - typeof signer.signEvent === "function"; - - if (canUseActiveSigner) { - let permissionResult = { ok: true }; - const shouldRequestPermissions = - typeof shouldRequestExtensionPermissions === "function" - ? shouldRequestExtensionPermissions(signer) - : false; - - if (shouldRequestPermissions) { - permissionResult = await client.ensureExtensionPermissions( - DEFAULT_NIP07_PERMISSION_METHODS, - ); - } - - if (permissionResult.ok) { - try { - signedEvent = await signer.signEvent(event); - } catch (error) { - userLogger.warn( - "[nostr] Failed to sign comment event with active signer:", - error, - ); - return { ok: false, error: "signing-failed", details: error }; - } - } else { - userLogger.warn( - "[nostr] Active signer permissions missing; signing comment with session key.", - permissionResult.error, - ); - } + if (!signer || typeof signer.signEvent !== "function") { + return { ok: false, error: "auth-required" }; } - if (!signedEvent) { - if (typeof signEventWithPrivateKey !== "function") { - return { ok: false, error: "signing-unavailable" }; - } - try { - if (!client.sessionActor || client.sessionActor.pubkey !== actorPubkey) { - await client.ensureSessionActor(true); - } - if (!client.sessionActor || client.sessionActor.pubkey !== actorPubkey) { - throw new Error("session-actor-mismatch"); - } - signedEvent = signEventWithPrivateKey( - event, - client.sessionActor.privateKey, - ); - } catch (error) { - userLogger.warn("[nostr] Failed to sign comment event with session key:", error); - return { ok: false, error: "signing-failed", details: error }; - } + let permissionResult = { ok: true }; + const shouldRequestPermissions = + typeof shouldRequestExtensionPermissions === "function" + ? shouldRequestExtensionPermissions(signer) + : false; + + if (shouldRequestPermissions) { + permissionResult = await client.ensureExtensionPermissions( + DEFAULT_NIP07_PERMISSION_METHODS, + ); + } + + if (!permissionResult.ok) { + userLogger.warn( + "[nostr] Active signer permissions missing; comment publish requires login.", + permissionResult.error, + ); + return { + ok: false, + error: "auth-required", + details: permissionResult, + }; + } + + try { + signedEvent = await signer.signEvent(event); + } catch (error) { + userLogger.warn( + "[nostr] Failed to sign comment event with active signer:", + error, + ); + return { ok: false, error: "signing-failed", details: error }; } const relayList = sanitizeRelayList(options.relays, client.relays); @@ -501,10 +1279,27 @@ export async function publishComment( } export async function listVideoComments(client, targetInput, options = {}) { - const pool = client?.pool; - const canQueryPool = pool && typeof pool.list === "function"; + let pool = client?.pool; + const ensurePool = + typeof client?.ensurePool === "function" + ? client.ensurePool.bind(client) + : null; - if (!canQueryPool) { + if (!pool || typeof pool.list !== "function") { + if (ensurePool) { + try { + pool = await ensurePool(); + } catch (error) { + devLogger.warn( + "[nostr] Unable to list video comments: pool init failed.", + error, + ); + return []; + } + } + } + + if (!pool || typeof pool.list !== "function") { devLogger.warn("[nostr] Unable to list video comments: pool missing."); return []; } @@ -578,13 +1373,10 @@ export async function listVideoComments(client, targetInput, options = {}) { } export function subscribeVideoComments(client, targetInput, options = {}) { - const pool = client?.pool; - const canSubscribe = pool && typeof pool.sub === "function"; - - if (!canSubscribe) { - devLogger.warn("[nostr] Unable to subscribe to video comments: pool missing."); - return () => {}; - } + const ensurePool = + typeof client?.ensurePool === "function" + ? client.ensurePool.bind(client) + : null; let descriptor; let filters; @@ -598,47 +1390,109 @@ export function subscribeVideoComments(client, targetInput, options = {}) { const relayList = sanitizeRelayList(options.relays, client.relays); const onEvent = typeof options.onEvent === "function" ? options.onEvent : null; - let subscription; - try { - subscription = pool.sub(relayList, filters); - } catch (error) { - devLogger.warn("[nostr] Failed to open video comment subscription:", error); - return () => {}; - } - - if (onEvent && subscription && typeof subscription.on === "function") { - try { - subscription.on("event", (event) => { - if (isVideoCommentEvent(event, descriptor)) { - try { - onEvent(event); - } catch (handlerError) { - devLogger.warn("[nostr] Comment subscription handler threw:", handlerError); - } - } - }); - } catch (error) { - devLogger.warn("[nostr] Failed to attach comment subscription handler:", error); - } - } - - const originalUnsub = - subscription && typeof subscription.unsub === "function" - ? subscription.unsub.bind(subscription) - : null; - + let activeSubscription = null; let unsubscribed = false; + + const ensureSubscription = async () => { + let pool = client?.pool; + if (!pool || typeof pool.sub !== "function") { + if (!ensurePool) { + devLogger.warn( + "[nostr] Unable to subscribe to video comments: pool missing.", + ); + return null; + } + try { + pool = await ensurePool(); + } catch (error) { + devLogger.warn( + "[nostr] Unable to subscribe to video comments: pool init failed.", + error, + ); + return null; + } + } + + if (!pool || typeof pool.sub !== "function") { + devLogger.warn( + "[nostr] Unable to subscribe to video comments: pool missing.", + ); + return null; + } + + try { + const subscription = pool.sub(relayList, filters); + if (unsubscribed) { + try { + subscription?.unsub?.(); + } catch (error) { + devLogger.warn( + "[nostr] Failed to unsubscribe from video comments:", + error, + ); + } + return null; + } + + if (onEvent && subscription && typeof subscription.on === "function") { + try { + subscription.on("event", (event) => { + if (isVideoCommentEvent(event, descriptor)) { + try { + onEvent(event); + } catch (handlerError) { + devLogger.warn( + "[nostr] Comment subscription handler threw:", + handlerError, + ); + } + } + }); + } catch (error) { + devLogger.warn( + "[nostr] Failed to attach comment subscription handler:", + error, + ); + } + } + + return subscription; + } catch (error) { + devLogger.warn("[nostr] Failed to open video comment subscription:", error); + return null; + } + }; + + const subscriptionPromise = ensureSubscription().then((subscription) => { + activeSubscription = subscription; + return subscription; + }); + return () => { if (unsubscribed) { return; } unsubscribed = true; - if (originalUnsub) { - try { - originalUnsub(); - } catch (error) { - devLogger.warn("[nostr] Failed to unsubscribe from video comments:", error); + + const teardown = (subscription) => { + if (subscription && typeof subscription.unsub === "function") { + try { + subscription.unsub(); + } catch (error) { + devLogger.warn( + "[nostr] Failed to unsubscribe from video comments:", + error, + ); + } } + }; + + if (activeSubscription) { + teardown(activeSubscription); + } else { + subscriptionPromise.finally(() => { + teardown(activeSubscription); + }); } }; } diff --git a/js/nostr/countDiagnostics.js b/js/nostr/countDiagnostics.js new file mode 100644 index 00000000..7f63c6b0 --- /dev/null +++ b/js/nostr/countDiagnostics.js @@ -0,0 +1,65 @@ +// js/nostr/countDiagnostics.js +// Centralized helpers for gating high-volume COUNT diagnostics (and other +// verbose nostr warnings) behind verbose dev mode while deduplicating repeated +// messages so the console stays readable during normal development sessions. + +import { devLogger } from "../utils/logger.js"; +import { isVerboseDevMode } from "../config.js"; + +const seenWarningKeys = new Set(); + +export function isVerboseDiagnosticsEnabled() { + if (typeof window !== "undefined" && window) { + const runtimeFlag = window.__BITVID_VERBOSE_DEV_MODE__; + if (typeof runtimeFlag === "boolean") { + return runtimeFlag; + } + } + return Boolean(isVerboseDevMode); +} + +function logCountWarning(message, args = [], { key, throttle = true } = {}) { + if (!isVerboseDiagnosticsEnabled()) { + return; + } + + if (throttle && key) { + const normalizedKey = String(key); + if (seenWarningKeys.has(normalizedKey)) { + return; + } + seenWarningKeys.add(normalizedKey); + } + + devLogger.warn(message, ...args); +} + +export function logCountTimeoutCleanupFailure(error) { + logCountWarning("[nostr] COUNT timeout cleanup failed:", [error], { + key: "count-timeout-cleanup", + }); +} + +export function logRelayCountFailure(url, error) { + const normalizedUrl = + typeof url === "string" && url.trim() ? url.trim() : "(unknown relay)"; + logCountWarning(`[nostr] COUNT request failed on ${normalizedUrl}:`, [error], { + key: `relay:${normalizedUrl}`, + }); +} + +export function logRebroadcastCountFailure(error) { + logCountWarning("[nostr] COUNT request for rebroadcast failed:", [error], { + key: "rebroadcast-count-failure", + }); +} + +export function logViewCountFailure(error) { + logCountWarning("[nostr] COUNT view request failed:", [error], { + key: "view-count-failure", + }); +} + +export function resetCountWarningHistory() { + seenWarningKeys.clear(); +} diff --git a/js/nostr/maxListenerDiagnostics.js b/js/nostr/maxListenerDiagnostics.js new file mode 100644 index 00000000..cc11d494 --- /dev/null +++ b/js/nostr/maxListenerDiagnostics.js @@ -0,0 +1,101 @@ +// js/nostr/maxListenerDiagnostics.js +// Suppresses noisy MaxListenersExceededWarning diagnostics unless verbose +// dev mode is enabled by shimming `process.emitWarning`. The EventEmitter +// polyfill used by nostr-tools surfaces listener leaks through +// `process.emitWarning`, so we intercept that hook instead of importing the +// Node `events` module (which breaks browser bundlers) or rewriting +// console.warn globally. + +import { isVerboseDiagnosticsEnabled } from "./countDiagnostics.js"; + +const MAX_LISTENER_SNIPPETS = [ + "MaxListenersExceededWarning", + "Possible EventEmitter memory leak detected", +]; + +const MAX_LISTENER_CODES = new Set(["MaxListenersExceededWarning"]); + +function collectCandidateStrings(value) { + const candidates = []; + + if (!value) { + return candidates; + } + + if (typeof value === "string") { + candidates.push(value); + return candidates; + } + + if (typeof value === "object") { + const fields = ["name", "message", "code", "type"]; + for (const field of fields) { + const fieldValue = value[field]; + if (typeof fieldValue === "string") { + candidates.push(fieldValue); + } + } + } + + return candidates; +} + +function shouldSuppressWarning(...args) { + if (isVerboseDiagnosticsEnabled()) { + return false; + } + + const candidates = []; + for (const arg of args) { + candidates.push(...collectCandidateStrings(arg)); + } + + for (const candidate of candidates) { + if (MAX_LISTENER_CODES.has(candidate)) { + return true; + } + if (MAX_LISTENER_SNIPPETS.some((snippet) => candidate.includes(snippet))) { + return true; + } + } + + return false; +} + +function patchProcessEmitWarning() { + const processRef = + typeof globalThis !== "undefined" && globalThis + ? globalThis.process + : typeof process !== "undefined" + ? process + : undefined; + + if (!processRef || typeof processRef.emitWarning !== "function") { + return; + } + + const originalEmitWarning = processRef.emitWarning.bind(processRef); + + if (processRef.emitWarning.__BITVID_MAX_LISTENER_PATCHED__) { + return; + } + + function patchedEmitWarning(warning, ...rest) { + if (shouldSuppressWarning(warning, ...rest)) { + return; + } + + return originalEmitWarning(warning, ...rest); + } + + patchedEmitWarning.__BITVID_MAX_LISTENER_PATCHED__ = true; + processRef.emitWarning = patchedEmitWarning; +} + +patchProcessEmitWarning(); + +export function refreshMaxListenerPreference() { + // The shim dynamically checks the verbose flag on each invocation, so there + // is nothing else to refresh right now. This placeholder remains for API + // parity if runtime toggling ever requires additional work. +} diff --git a/js/nostr/nip71.js b/js/nostr/nip71.js index 26bc5fc9..249d5fe4 100644 --- a/js/nostr/nip71.js +++ b/js/nostr/nip71.js @@ -2,6 +2,7 @@ import { ACCEPT_LEGACY_V1 } from "../constants.js"; import { deriveTitleFromEvent, magnetFromText } from "../videoEventUtils.js"; import { extractMagnetHints } from "../magnet.js"; import { devLogger } from "../utils/logger.js"; +import { getCachedNostrTools } from "./toolkit.js"; function stringFromInput(value) { if (value === null || value === undefined) { @@ -16,6 +17,50 @@ function stringFromInput(value) { return String(value).trim(); } +const HEX_32_BYTE_REGEX = /^[0-9a-f]{64}$/i; + +function decodeNpubToHex(candidate) { + const globalDecoder = + typeof window !== "undefined" ? window?.NostrTools?.nip19?.decode : null; + const toolkit = getCachedNostrTools(); + const toolkitDecoder = toolkit?.nip19?.decode; + const decoder = + typeof globalDecoder === "function" ? globalDecoder : toolkitDecoder; + if (typeof decoder !== "function") { + return null; + } + try { + const decoded = decoder(candidate); + if (decoded?.type === "npub" && typeof decoded.data === "string") { + return decoded.data.toLowerCase(); + } + if (decoded?.type === "npub" && typeof decoded.data?.pubkey === "string") { + return decoded.data.pubkey.toLowerCase(); + } + } catch (error) { + devLogger.warn("[nostr] Failed to decode npub participant pubkey", error); + } + return null; +} + +function normalizeNostrPubkey(candidate) { + const value = stringFromInput(candidate); + if (!value) { + return null; + } + if (HEX_32_BYTE_REGEX.test(value)) { + return value.toLowerCase(); + } + if (value.toLowerCase().startsWith("npub1")) { + const decoded = decodeNpubToHex(value); + if (decoded && HEX_32_BYTE_REGEX.test(decoded)) { + return decoded; + } + return null; + } + return null; +} + function normalizeUnixSeconds(value) { if (value === null || value === undefined || value === "") { return ""; @@ -42,23 +87,60 @@ function normalizeUnixSeconds(value) { return ""; } -function normalizeDurationSeconds(value) { +function parseNonNegativeNumber(value, { allowFloat = false } = {}) { + if (typeof value === "number" && Number.isFinite(value)) { + if (!allowFloat && !Number.isInteger(value)) { + return null; + } + return value >= 0 ? value : null; + } + if (typeof value === "string") { + const trimmed = value.trim(); + if (!trimmed) { + return null; + } + const numeric = Number(trimmed); + if (!Number.isFinite(numeric)) { + return null; + } + if (!allowFloat && !Number.isInteger(numeric)) { + return null; + } + return numeric >= 0 ? numeric : null; + } + return null; +} + +function formatNonNegativeNumber(value, { allowFloat = false } = {}) { if (value === null || value === undefined || value === "") { return ""; } - if (typeof value === "number" && Number.isFinite(value)) { - return String(Math.max(0, Math.floor(value))); - } + if (typeof value === "string") { const trimmed = value.trim(); if (!trimmed) { return ""; } const numeric = Number(trimmed); - if (Number.isFinite(numeric)) { - return String(Math.max(0, Math.floor(numeric))); + if (!Number.isFinite(numeric) || numeric < 0) { + return ""; } + if (!allowFloat && !Number.isInteger(numeric)) { + return ""; + } + if (/^\d+(?:\.\d+)?$/.test(trimmed)) { + return trimmed; + } + return allowFloat ? String(numeric) : String(Math.trunc(numeric)); } + + if (typeof value === "number" && Number.isFinite(value) && value >= 0) { + if (!allowFloat && !Number.isInteger(value)) { + return ""; + } + return String(value); + } + return ""; } @@ -95,7 +177,14 @@ function buildImetaTags(variants) { const dim = stringFromInput(variant.dim); const url = stringFromInput(variant.url); const x = stringFromInput(variant.x); - const mime = stringFromInput(variant.m); + const rawMime = stringFromInput(variant.m); + const mime = rawMime ? rawMime.toLowerCase() : ""; + const duration = formatNonNegativeNumber(variant.duration, { + allowFloat: true, + }); + const bitrate = formatNonNegativeNumber(variant.bitrate, { + allowFloat: false, + }); const image = Array.isArray(variant.image) ? variant.image.map(stringFromInput).filter(Boolean) : []; @@ -106,7 +195,17 @@ function buildImetaTags(variants) { ? variant.service.map(stringFromInput).filter(Boolean) : []; - if (!dim && !url && !x && !mime && !image.length && !fallback.length && !service.length) { + if ( + !dim && + !url && + !x && + !mime && + !duration && + !bitrate && + !image.length && + !fallback.length && + !service.length + ) { continue; } @@ -123,6 +222,12 @@ function buildImetaTags(variants) { if (mime) { entries.push(`m ${mime}`); } + if (duration) { + entries.push(`duration ${duration}`); + } + if (bitrate) { + entries.push(`bitrate ${bitrate}`); + } image.forEach((value) => entries.push(`image ${value}`)); fallback.forEach((value) => entries.push(`fallback ${value}`)); service.forEach((value) => entries.push(`service ${value}`)); @@ -165,11 +270,20 @@ function buildParticipantTag(participant) { if (!participant || typeof participant !== "object") { return null; } - const pubkey = stringFromInput(participant.pubkey); + const rawPubkey = participant.pubkey; + const pubkey = normalizeNostrPubkey(rawPubkey); if (!pubkey) { + const candidate = stringFromInput(rawPubkey); + if (candidate) { + devLogger.warn( + "[nostr] Dropping NIP-71 participant tag with invalid pubkey", + { pubkey: candidate } + ); + } return null; } const relay = stringFromInput(participant.relay); + // NIP-71 "Other tags" mandates 32-byte hex participant pubkeys. const values = ["p", pubkey]; if (relay) { values.push(relay); @@ -204,11 +318,6 @@ export function buildNip71MetadataTags(metadata) { tags.push(...imetaTags); } - const duration = normalizeDurationSeconds(metadata.duration); - if (duration) { - tags.push(["duration", duration]); - } - if (Array.isArray(metadata.textTracks)) { metadata.textTracks.forEach((track) => { const tag = buildTextTrackTag(track); @@ -312,6 +421,18 @@ function parseImetaTag(tag) { case "m": variant.m = parsed.value; break; + case "duration": { + const numeric = parseNonNegativeNumber(parsed.value, { + allowFloat: true, + }); + variant.duration = numeric ?? parsed.value; + break; + } + case "bitrate": { + const numeric = parseNonNegativeNumber(parsed.value); + variant.bitrate = numeric ?? parsed.value; + break; + } case "image": variant.image.push(parsed.value); break; @@ -331,6 +452,8 @@ function parseImetaTag(tag) { Boolean(variant.url) || Boolean(variant.x) || Boolean(variant.m) || + (variant.duration !== undefined && variant.duration !== null && variant.duration !== "") || + (variant.bitrate !== undefined && variant.bitrate !== null && variant.bitrate !== "") || variant.image.length > 0 || variant.fallback.length > 0 || variant.service.length > 0; @@ -348,6 +471,12 @@ function parseImetaTag(tag) { if (!variant.service.length) { delete variant.service; } + if (variant.duration === "" || variant.duration === undefined) { + delete variant.duration; + } + if (variant.bitrate === "" || variant.bitrate === undefined) { + delete variant.bitrate; + } return variant; } @@ -595,6 +724,22 @@ export function extractNip71MetadataFromTags(event) { if (imeta.length) { metadata.imeta = imeta; + + const legacyDuration = parseNonNegativeNumber(metadata.duration, { + allowFloat: true, + }); + + if (legacyDuration !== null) { + metadata.duration = legacyDuration; + } else { + const variantDurations = imeta + .map((variant) => parseNonNegativeNumber(variant?.duration, { allowFloat: true })) + .filter((value) => value !== null); + + if (variantDurations.length) { + metadata.duration = Math.max(...variantDurations); + } + } } if (textTracks.length) { metadata.textTracks = textTracks; @@ -1084,23 +1229,30 @@ export async function populateNip71MetadataForVideos(videos = [], { }); } -const EXTENSION_MIME_MAP = { - mp4: "video/mp4", - m4v: "video/x-m4v", - webm: "video/webm", - mkv: "video/x-matroska", - mov: "video/quicktime", - avi: "video/x-msvideo", - ogv: "video/ogg", - ogg: "video/ogg", - m3u8: "application/x-mpegURL", - mpd: "application/dash+xml", - ts: "video/mp2t", - mpg: "video/mpeg", - mpeg: "video/mpeg", - flv: "video/x-flv", - "3gp": "video/3gpp", -}; +const EXTENSION_MIME_MAP = Object.freeze( + Object.fromEntries( + Object.entries({ + mp4: "video/mp4", + m4v: "video/x-m4v", + webm: "video/webm", + mkv: "video/x-matroska", + mov: "video/quicktime", + avi: "video/x-msvideo", + ogv: "video/ogg", + ogg: "video/ogg", + m3u8: "application/x-mpegurl", + mpd: "application/dash+xml", + ts: "video/mp2t", + mpg: "video/mpeg", + mpeg: "video/mpeg", + flv: "video/x-flv", + "3gp": "video/3gpp", + }).map(([extension, mimeType]) => [ + extension, + typeof mimeType === "string" ? mimeType.toLowerCase() : "", + ]), + ), +); function inferMimeTypeFromUrl(url) { if (!url || typeof url !== "string") { @@ -1123,7 +1275,8 @@ function inferMimeTypeFromUrl(url) { } const extension = match[1].toLowerCase(); - return EXTENSION_MIME_MAP[extension] || ""; + const mimeType = EXTENSION_MIME_MAP[extension]; + return typeof mimeType === "string" ? mimeType : ""; } export function convertEventToVideo(event = {}) { diff --git a/js/nostr/publishHelpers.js b/js/nostr/publishHelpers.js index 077dde60..44da23d8 100644 --- a/js/nostr/publishHelpers.js +++ b/js/nostr/publishHelpers.js @@ -1,12 +1,14 @@ -import { - ENSURE_PRESENCE_REBROADCAST_COOLDOWN_SECONDS, -} from "../config.js"; +import { ENSURE_PRESENCE_REBROADCAST_COOLDOWN_SECONDS } from "../config.js"; import { publishEventToRelays, assertAnyRelayAccepted, summarizePublishResults, } from "../nostrPublish.js"; -import { buildRepostEvent, buildVideoMirrorEvent } from "../nostrEventSchemas.js"; +import { + buildRepostEvent, + buildVideoMirrorEvent, + sanitizeAdditionalTags, +} from "../nostrEventSchemas.js"; import { normalizePointerInput } from "./watchHistory.js"; import { sanitizeRelayList } from "./nip46Client.js"; import { @@ -16,11 +18,28 @@ import { } from "./toolkit.js"; import { DEFAULT_NIP07_PERMISSION_METHODS } from "./nip07Permissions.js"; import { devLogger, userLogger } from "../utils/logger.js"; +import { logRebroadcastCountFailure } from "./countDiagnostics.js"; const REBROADCAST_GUARD_PREFIX = "bitvid:rebroadcast:v1"; const rebroadcastAttemptMemory = new Map(); const HEX_PRIVATE_KEY_REGEX = /^[0-9a-f]{64}$/i; +const HEX64_REGEX = /^[0-9a-f]{64}$/i; + +function normalizeSha256TagValue(value) { + if (value === undefined || value === null) { + return ""; + } + const stringValue = typeof value === "string" ? value : String(value); + const trimmed = stringValue.trim().toLowerCase(); + if (!trimmed) { + return ""; + } + if (!HEX64_REGEX.test(trimmed)) { + return null; + } + return trimmed; +} export function signEventWithPrivateKey(event, privateKey) { const tools = getCachedNostrTools(); @@ -505,6 +524,22 @@ export async function repostEvent({ const cachedVideo = client?.allEvents?.get(normalizedId) || null; const cachedRaw = client?.rawEvents?.get(normalizedId) || null; + let resolvedRawEvent = cachedRaw; + const serializeEvent = (event) => { + if (!event || typeof event !== "object") { + return ""; + } + try { + return JSON.stringify(event); + } catch (error) { + devLogger.warn( + `[nostr] Failed to serialize repost target ${normalizedId}`, + error, + ); + return ""; + } + }; + let serializedSourceEvent = serializeEvent(resolvedRawEvent); let authorPubkey = typeof options.authorPubkey === "string" && options.authorPubkey.trim() @@ -529,10 +564,126 @@ export async function repostEvent({ addressRelay = pointer.relay; } + const relayCandidates = new Set(); + + const rememberRelayCandidate = (value) => { + if (typeof value !== "string") { + return; + } + const normalized = value.trim(); + if (!normalized) { + return; + } + relayCandidates.add(normalized); + }; + + const rememberPointerRelay = (pointerCandidate) => { + const normalizedPointer = normalizePointerInput(pointerCandidate); + if (normalizedPointer?.relay) { + rememberRelayCandidate(normalizedPointer.relay); + } + }; + + const rememberRelayHintsFromObject = (candidate, depth = 0) => { + if (!candidate || typeof candidate !== "object" || depth > 3) { + return; + } + + const directKeys = [ + "relay", + "relayUrl", + "eventRelay", + "pointerRelay", + "sourceRelay", + "originRelay", + "addressRelay", + ]; + directKeys.forEach((key) => { + if (typeof candidate[key] === "string") { + rememberRelayCandidate(candidate[key]); + } + }); + + if (Array.isArray(candidate.relays)) { + candidate.relays.forEach((value) => { + rememberRelayCandidate(value); + }); + } + + if (candidate.pointer) { + rememberPointerRelay(candidate.pointer); + } + if (candidate.eventPointer) { + rememberPointerRelay(candidate.eventPointer); + } + + if (candidate.pointerInfo && depth <= 3) { + rememberRelayHintsFromObject(candidate.pointerInfo, depth + 1); + } + + if (Array.isArray(candidate.pointers)) { + candidate.pointers.forEach((pointerCandidate) => { + rememberPointerRelay(pointerCandidate); + }); + } + + if (candidate.video && depth <= 3) { + rememberRelayHintsFromObject(candidate.video, depth + 1); + } + }; + let eventRelay = typeof options.eventRelay === "string" ? options.eventRelay.trim() : ""; - if (!eventRelay && pointer?.type === "e" && pointer.relay) { - eventRelay = pointer.relay; + if (eventRelay) { + rememberRelayCandidate(eventRelay); + } + + if (pointer) { + rememberPointerRelay(pointer); + if (!eventRelay && pointer.type === "e" && pointer.relay) { + eventRelay = pointer.relay; + } + } + + rememberRelayHintsFromObject(options); + rememberRelayHintsFromObject(pointer); + rememberRelayHintsFromObject(cachedVideo); + rememberRelayHintsFromObject(cachedVideo?.pointerInfo); + rememberRelayHintsFromObject(cachedRaw); + + if (addressRelay) { + rememberRelayCandidate(addressRelay); + } + + const deriveRelayFromRawEvent = (event) => { + if (!event || typeof event !== "object") { + return ""; + } + const directRelay = + typeof event.relay === "string" ? event.relay.trim() : ""; + if (directRelay) { + return directRelay; + } + const relayCollections = [event.relays, event.seenOn, event.seen_on]; + for (const collection of relayCollections) { + if (!Array.isArray(collection)) { + continue; + } + for (const entry of collection) { + if (typeof entry === "string" && entry.trim()) { + return entry.trim(); + } + } + } + return ""; + }; + + const cachedRawRelay = deriveRelayFromRawEvent(cachedRaw); + if (cachedRawRelay) { + rememberRelayCandidate(cachedRawRelay); + if (!eventRelay) { + eventRelay = cachedRawRelay; + } } let targetKind = Number.isFinite(options.kind) @@ -627,6 +778,84 @@ export async function repostEvent({ : client?.relays, ); const relays = relaysOverride.length ? relaysOverride : Array.from(RELAY_URLS); + const probeRelays = (() => { + const order = []; + if (eventRelay) { + order.push(eventRelay); + } + relayCandidates.forEach((relayUrl) => { + if (relayUrl && !order.includes(relayUrl)) { + order.push(relayUrl); + } + }); + relays.forEach((relayUrl) => { + if (relayUrl && !order.includes(relayUrl)) { + order.push(relayUrl); + } + }); + return order; + })(); + + if ((!eventRelay || !resolvedRawEvent) && typeof client?.fetchRawEventById === "function") { + for (const relayUrl of probeRelays) { + if (!relayUrl) { + continue; + } + if (!resolvedRawEvent) { + try { + const fetched = await client.fetchRawEventById(normalizedId, { + relays: [relayUrl], + }); + if (fetched) { + resolvedRawEvent = fetched; + serializedSourceEvent = serializeEvent(fetched); + } + } catch (error) { + devLogger.warn( + `[nostr] Failed to fetch ${normalizedId} from ${relayUrl} while preparing repost`, + error, + ); + } + } + + if (!eventRelay && resolvedRawEvent) { + eventRelay = relayUrl; + rememberRelayCandidate(relayUrl); + } + + if (eventRelay && resolvedRawEvent) { + break; + } + } + } + + if (resolvedRawEvent && !serializedSourceEvent) { + serializedSourceEvent = serializeEvent(resolvedRawEvent); + } + + if (resolvedRawEvent && !eventRelay) { + const rawRelay = deriveRelayFromRawEvent(resolvedRawEvent); + if (rawRelay) { + eventRelay = rawRelay; + rememberRelayCandidate(rawRelay); + } + } + + if (!eventRelay) { + devLogger.warn( + `[nostr] Repost aborted: missing source relay for ${normalizedId}`, + { candidates: probeRelays }, + ); + return { + ok: false, + error: "missing-event-relay", + details: { relays: probeRelays }, + }; + } + + devLogger.log( + `[nostr] Resolved repost target relay ${eventRelay} for ${normalizedId}`, + ); let actorPubkey = typeof options.actorPubkey === "string" && options.actorPubkey.trim() @@ -668,9 +897,12 @@ export async function repostEvent({ ? Math.max(0, Math.floor(options.created_at)) : Math.floor(Date.now() / 1000); - const additionalTags = Array.isArray(options.additionalTags) - ? options.additionalTags.filter((tag) => Array.isArray(tag) && tag.length >= 2) - : []; + const additionalTags = sanitizeAdditionalTags(options.additionalTags); + + const repostKind = + Number.isFinite(targetKind) && targetKind !== 1 + ? 16 + : 6; const repostEventPayload = buildRepostEvent({ pubkey: actorPubkey, @@ -681,6 +913,10 @@ export async function repostEvent({ addressRelay, authorPubkey, additionalTags, + repostKind, + targetKind, + targetEvent: resolvedRawEvent, + serializedEvent: serializedSourceEvent, }); try { @@ -712,6 +948,10 @@ export async function repostEvent({ normalizedSigner !== normalizedLogged && normalizedSigner === sessionPubkey; + const sourceInfo = serializedSourceEvent + ? { raw: resolvedRawEvent, serialized: serializedSourceEvent } + : null; + return { ok: true, event: signedEvent, @@ -719,6 +959,7 @@ export async function repostEvent({ relays, sessionActor: usedSessionActor, signerPubkey, + source: sourceInfo, }; } catch (error) { devLogger.warn("[nostr] Repost publish failed:", error); @@ -792,14 +1033,36 @@ export async function mirrorVideoEvent({ } const providedMimeType = sanitize(options.mimeType); + const normalizedProvidedMimeType = providedMimeType + ? providedMimeType.toLowerCase() + : ""; const inferredMimeType = inferMimeTypeFromUrl ? inferMimeTypeFromUrl(url) : ""; - const mimeType = providedMimeType || inferredMimeType || "application/octet-stream"; + const normalizedInferredMimeType = inferredMimeType + ? inferredMimeType.toLowerCase() + : ""; + const mimeTypeSource = + normalizedProvidedMimeType || + normalizedInferredMimeType || + "application/octet-stream"; + const mimeType = mimeTypeSource.toLowerCase(); const explicitAlt = sanitize(options.altText); const altText = explicitAlt || description || title || ""; + const fileSha256 = normalizeSha256TagValue(options.fileSha256); + if (fileSha256 === null) { + return { ok: false, error: "invalid-file-sha" }; + } + + const originalFileSha256 = normalizeSha256TagValue( + options.originalFileSha256, + ); + if (originalFileSha256 === null) { + return { ok: false, error: "invalid-original-file-sha" }; + } + const tags = []; tags.push(["url", url]); if (mimeType) { @@ -814,11 +1077,17 @@ export async function mirrorVideoEvent({ if (!isPrivate && magnet) { tags.push(["magnet", magnet]); } + if (fileSha256) { + tags.push(["x", fileSha256]); + } + if (originalFileSha256) { + tags.push(["ox", originalFileSha256]); + } - const additionalTags = Array.isArray(options.additionalTags) - ? options.additionalTags.filter((tag) => Array.isArray(tag) && tag.length >= 2) - : []; - tags.push(...additionalTags); + const additionalTags = sanitizeAdditionalTags(options.additionalTags); + if (additionalTags.length) { + tags.push(...additionalTags.map((tag) => tag.slice())); + } let actorPubkey = typeof options.actorPubkey === "string" && options.actorPubkey.trim() @@ -1023,7 +1292,7 @@ export async function rebroadcastEvent({ client, eventId, options = {} }) { }) : null; } catch (error) { - devLogger.warn("[nostr] COUNT request for rebroadcast failed:", error); + logRebroadcastCountFailure(error); } if (countResult?.total && Number(countResult.total) > 0) { diff --git a/js/nostr/reactionEvents.js b/js/nostr/reactionEvents.js index 475dc92a..fba80c4c 100644 --- a/js/nostr/reactionEvents.js +++ b/js/nostr/reactionEvents.js @@ -1,4 +1,4 @@ -import { buildReactionEvent } from "../nostrEventSchemas.js"; +import { buildReactionEvent, sanitizeAdditionalTags } from "../nostrEventSchemas.js"; import { publishEventToRelay } from "../nostrPublish.js"; import { RELAY_URLS } from "./toolkit.js"; import { normalizePointerInput } from "./watchHistory.js"; @@ -14,6 +14,119 @@ function sanitizeRelayList(primary, fallback) { return RELAY_URLS; } +function normalizeString(value) { + return typeof value === "string" ? value.trim() : ""; +} + +function extractEventIdFromPointerInput(pointerInput) { + if (!pointerInput) { + return ""; + } + + if (Array.isArray(pointerInput)) { + if ( + pointerInput.length >= 2 && + pointerInput[0] === "e" && + typeof pointerInput[1] === "string" + ) { + const candidate = pointerInput[1].trim(); + if (candidate) { + return candidate; + } + } + return ""; + } + + if (typeof pointerInput !== "object") { + return ""; + } + + const candidateKeys = ["eventId", "pointerEventId", "id"]; + for (const key of candidateKeys) { + const candidate = normalizeString(pointerInput[key]); + if (candidate) { + return candidate; + } + } + + const normalizedType = normalizeString(pointerInput.type); + if (normalizedType === "e") { + const candidate = normalizeString(pointerInput.value); + if (candidate) { + return candidate; + } + } + + if (pointerInput.pointer) { + const nested = extractEventIdFromPointerInput(pointerInput.pointer); + if (nested) { + return nested; + } + } + + if (pointerInput.tag) { + const nested = extractEventIdFromPointerInput(pointerInput.tag); + if (nested) { + return nested; + } + } + + return ""; +} + +function extractEventRelayFromPointerInput(pointerInput) { + if (!pointerInput) { + return ""; + } + + if (Array.isArray(pointerInput)) { + if ( + pointerInput.length >= 3 && + pointerInput[0] === "e" && + typeof pointerInput[2] === "string" + ) { + const candidate = pointerInput[2].trim(); + if (candidate) { + return candidate; + } + } + return ""; + } + + if (typeof pointerInput !== "object") { + return ""; + } + + const candidateRelay = normalizeString(pointerInput.eventRelay); + if (candidateRelay) { + return candidateRelay; + } + + const normalizedType = normalizeString(pointerInput.type); + if (normalizedType === "e") { + const relayCandidate = normalizeString(pointerInput.relay); + if (relayCandidate) { + return relayCandidate; + } + } + + if (pointerInput.pointer) { + const nested = extractEventRelayFromPointerInput(pointerInput.pointer); + if (nested) { + return nested; + } + } + + if (pointerInput.tag) { + const nested = extractEventRelayFromPointerInput(pointerInput.tag); + if (nested) { + return nested; + } + } + + return ""; +} + export async function publishVideoReaction( client, pointerInput, @@ -44,11 +157,7 @@ export async function publishVideoReaction( ? Math.floor(options.created_at) : Math.floor(Date.now() / 1000); - const additionalTags = Array.isArray(options.additionalTags) - ? options.additionalTags.filter( - (tag) => Array.isArray(tag) && typeof tag[0] === "string" - ) - : []; + const additionalTags = sanitizeAdditionalTags(options.additionalTags); const optionRelay = typeof options.pointerRelay === "string" && options.pointerRelay.trim() @@ -60,14 +169,69 @@ export async function publishVideoReaction( ? pointer.relay.trim() : optionRelay; - const pointerTag = - pointer.type === "a" - ? pointerRelay - ? ["a", pointer.value, pointerRelay] - : ["a", pointer.value] - : pointerRelay - ? ["e", pointer.value, pointerRelay] - : ["e", pointer.value]; + let pointerEventId = normalizeString(pointer.type === "e" ? pointer.value : ""); + if (!pointerEventId) { + pointerEventId = extractEventIdFromPointerInput(pointerInput); + } + if (!pointerEventId) { + pointerEventId = normalizeString(options.pointerEventId); + } + if (!pointerEventId && options.video) { + pointerEventId = + extractEventIdFromPointerInput(options.video.pointerInfo) || + normalizeString(options.video.pointerEventId) || + normalizeString(options.video.eventId) || + normalizeString(options.video.id); + } + + let pointerEventRelay = normalizeString( + pointer.type === "e" ? pointer.relay : "" + ); + if (!pointerEventRelay) { + pointerEventRelay = extractEventRelayFromPointerInput(pointerInput); + } + if (!pointerEventRelay) { + pointerEventRelay = normalizeString(options.pointerEventRelay); + } + if (!pointerEventRelay && options.video) { + pointerEventRelay = + normalizeString(options.video.pointerInfo?.eventRelay) || + extractEventRelayFromPointerInput(options.video.pointerInfo) || + normalizeString(options.video.eventRelay) || + normalizeString(options.video.relay); + } + if (!pointerEventRelay && pointerRelay) { + pointerEventRelay = pointerRelay; + } + + if (!pointerEventId) { + const errorDetails = pointer.type === "a" + ? "Unable to resolve event id for address reaction target." + : "Unable to resolve event id for reaction target."; + devLogger.warn("[nostr] " + errorDetails, pointerInput); + return { ok: false, error: "missing-pointer-event-id", details: errorDetails }; + } + + const pointerTags = []; + let pointerTag = null; + + if (pointer.type === "a") { + const addressTag = pointerRelay + ? ["a", pointer.value, pointerRelay] + : ["a", pointer.value]; + pointerTags.push(addressTag); + pointerTag = addressTag; + } + + const eventTag = pointerEventRelay + ? ["e", pointerEventId, pointerEventRelay] + : ["e", pointerEventId]; + + pointerTags.push(eventTag); + + if (!pointerTag) { + pointerTag = eventTag; + } const normalizedPointer = { type: pointer.type, @@ -105,6 +269,7 @@ export async function publishVideoReaction( created_at: createdAt, pointerValue: pointer.value, pointerTag, + pointerTags, targetPointer: normalizedPointer, targetAuthorPubkey: explicitTargetAuthor, additionalTags, diff --git a/js/nostr/viewEvents.js b/js/nostr/viewEvents.js index 723b93b0..44c11da2 100644 --- a/js/nostr/viewEvents.js +++ b/js/nostr/viewEvents.js @@ -7,11 +7,13 @@ import { buildViewEvent, getNostrEventSchema, NOTE_TYPES, + sanitizeAdditionalTags, } from "../nostrEventSchemas.js"; import { publishEventToRelay } from "../nostrPublish.js"; import { RELAY_URLS } from "./toolkit.js"; import { normalizePointerInput } from "./watchHistory.js"; import { devLogger, userLogger } from "../utils/logger.js"; +import { logViewCountFailure } from "./countDiagnostics.js"; const VIEW_EVENT_GUARD_PREFIX = "bitvid:viewed"; @@ -590,7 +592,7 @@ export async function countVideoViewEvents(client, pointer, options = {}) { } } catch (error) { if (error?.code !== "count-unsupported") { - devLogger.warn("[nostr] COUNT view request failed:", error); + logViewCountFailure(error); } } @@ -709,11 +711,7 @@ export async function publishViewEvent( const usingSessionActor = normalizedActor && normalizedActor !== normalizedLogged; - const additionalTags = Array.isArray(options.additionalTags) - ? options.additionalTags.filter( - (tag) => Array.isArray(tag) && typeof tag[0] === "string" - ) - : []; + const additionalTags = sanitizeAdditionalTags(options.additionalTags); const pointerTag = pointer.type === "a" diff --git a/js/nostr/watchHistory.js b/js/nostr/watchHistory.js index d8878e60..8529bee1 100644 --- a/js/nostr/watchHistory.js +++ b/js/nostr/watchHistory.js @@ -34,6 +34,11 @@ const WATCH_HISTORY_REPUBLISH_BASE_DELAY_MS = 2000; const WATCH_HISTORY_REPUBLISH_MAX_DELAY_MS = 5 * 60 * 1000; const WATCH_HISTORY_REPUBLISH_MAX_ATTEMPTS = 8; const WATCH_HISTORY_REPUBLISH_JITTER = 0.25; +const WATCH_HISTORY_ENCRYPTION_FALLBACK_ORDER = Object.freeze([ + "nip44_v2", + "nip44", + "nip04", +]); function cloneVideoMetadata(video) { if (!video || typeof video !== "object") { @@ -657,6 +662,239 @@ function looksLikeJsonStructure(content) { return first === "{" || first === "["; } +function hexToBytesCompat(hex, tools = null) { + if (typeof hex !== "string") { + throw new Error("Invalid hex input."); + } + const trimmed = hex.trim(); + if (!trimmed || trimmed.length % 2 !== 0) { + throw new Error("Invalid hex input."); + } + if (tools?.utils && typeof tools.utils.hexToBytes === "function") { + return tools.utils.hexToBytes(trimmed); + } + const bytes = new Uint8Array(trimmed.length / 2); + for (let index = 0; index < trimmed.length; index += 2) { + const byte = Number.parseInt(trimmed.slice(index, index + 2), 16); + if (Number.isNaN(byte)) { + throw new Error("Invalid hex input."); + } + bytes[index / 2] = byte; + } + return bytes; +} + +function createNip44CipherSuite(tools, privateKeyHex, targetPubkeyHex) { + if (!tools || !privateKeyHex || !targetPubkeyHex) { + return null; + } + const normalizedPrivateKey = + typeof privateKeyHex === "string" && privateKeyHex.trim() + ? privateKeyHex.trim().toLowerCase() + : ""; + const normalizedTarget = + typeof targetPubkeyHex === "string" && targetPubkeyHex.trim() + ? targetPubkeyHex.trim().toLowerCase() + : ""; + if (!normalizedPrivateKey || !normalizedTarget) { + return null; + } + + let privateKeyBytes; + try { + privateKeyBytes = hexToBytesCompat(normalizedPrivateKey, tools); + } catch (_) { + return null; + } + + const nip44 = tools?.nip44 && typeof tools.nip44 === "object" ? tools.nip44 : null; + const suite = {}; + + const nip44v2 = nip44?.v2 && typeof nip44.v2 === "object" ? nip44.v2 : null; + if ( + nip44v2 && + typeof nip44v2.encrypt === "function" && + typeof nip44v2.decrypt === "function" && + typeof nip44v2?.utils?.getConversationKey === "function" + ) { + let cachedKey = null; + const ensureKey = () => { + if (!cachedKey) { + cachedKey = nip44v2.utils.getConversationKey(privateKeyBytes, normalizedTarget); + } + return cachedKey; + }; + suite.v2 = { + encrypt: (plaintext) => nip44v2.encrypt(plaintext, ensureKey()), + decrypt: (ciphertext) => nip44v2.decrypt(ciphertext, ensureKey()), + }; + } + + const legacyGetConversationKey = (() => { + if (typeof nip44?.getConversationKey === "function") { + return nip44.getConversationKey.bind(nip44); + } + if (typeof nip44?.utils?.getConversationKey === "function") { + return nip44.utils.getConversationKey.bind(nip44.utils); + } + return null; + })(); + + if ( + typeof nip44?.encrypt === "function" && + typeof nip44?.decrypt === "function" && + typeof legacyGetConversationKey === "function" + ) { + let cachedKey = null; + const ensureLegacyKey = () => { + if (!cachedKey) { + cachedKey = legacyGetConversationKey(privateKeyBytes, normalizedTarget); + } + return cachedKey; + }; + suite.legacy = { + encrypt: (plaintext) => nip44.encrypt(plaintext, ensureLegacyKey()), + decrypt: (ciphertext) => nip44.decrypt(ciphertext, ensureLegacyKey()), + }; + } + + if (!suite.v2 && !suite.legacy) { + return null; + } + + return suite; +} + +function normalizeEncryptionTagValue(value) { + if (typeof value !== "string") { + return ""; + } + const normalized = value.trim().toLowerCase(); + switch (normalized) { + case "nip04": + case "nip-04": + case "nip4": + return "nip04"; + case "nip44_v2": + case "nip44-v2": + case "nip44v2": + return "nip44_v2"; + case "nip44_v1": + case "nip44-v1": + case "nip44v1": + case "nip44": + return "nip44"; + default: + return ""; + } +} + +function extractWatchHistoryEncryptionHints(event, ciphertext) { + const hints = []; + const pushUnique = (hint) => { + if (hint && !hints.includes(hint)) { + hints.push(hint); + } + }; + + const tags = Array.isArray(event?.tags) ? event.tags : []; + for (const tag of tags) { + if (!Array.isArray(tag) || tag.length < 2) { + continue; + } + const label = typeof tag[0] === "string" ? tag[0].trim().toLowerCase() : ""; + if (label !== "encrypted") { + continue; + } + const normalizedValue = normalizeEncryptionTagValue(tag[1]); + if (normalizedValue) { + pushUnique(normalizedValue); + } + } + + if (!hints.length && isNip04EncryptedWatchHistoryEvent(event, ciphertext)) { + pushUnique("nip04"); + } + + return hints; +} + +function determineWatchHistoryDecryptionOrder( + event, + ciphertext, + availableSchemes = [], +) { + const available = Array.isArray(availableSchemes) ? availableSchemes : []; + const availableSet = new Set(available); + const prioritized = []; + const hints = extractWatchHistoryEncryptionHints(event, ciphertext); + const aliasMap = { + nip04: ["nip04"], + nip44: ["nip44", "nip44_v2"], + nip44_v2: ["nip44_v2", "nip44"], + }; + + for (const hint of hints) { + const candidates = Array.isArray(aliasMap[hint]) ? aliasMap[hint] : [hint]; + for (const candidate of candidates) { + if (availableSet.has(candidate) && !prioritized.includes(candidate)) { + prioritized.push(candidate); + break; + } + } + } + + for (const fallback of WATCH_HISTORY_ENCRYPTION_FALLBACK_ORDER) { + if (availableSet.has(fallback) && !prioritized.includes(fallback)) { + prioritized.push(fallback); + } + } + + return prioritized.length ? prioritized : available; +} + +async function resolveNostrToolkit(deps = {}, cacheRef = null) { + if (cacheRef?.current) { + return cacheRef.current; + } + + const ensureToolkit = + typeof deps.ensureNostrTools === "function" ? deps.ensureNostrTools : ensureNostrTools; + if (ensureToolkit) { + try { + const ensured = await ensureToolkit(); + if (ensured) { + if (cacheRef) { + cacheRef.current = ensured; + } + return ensured; + } + } catch (error) { + devLogger.warn("[nostr] Failed to resolve nostr-tools for watch history:", error); + } + } + + const readCachedToolkit = + typeof deps.getCachedNostrTools === "function" + ? deps.getCachedNostrTools + : getCachedNostrTools; + if (readCachedToolkit) { + try { + const cached = await readCachedToolkit(); + if (cached) { + if (cacheRef) { + cacheRef.current = cached; + } + return cached; + } + } catch (error) { + devLogger.warn("[nostr] Failed to read cached nostr-tools for watch history:", error); + } + } + + return cacheRef?.current || null; +} + function mergeWatchHistoryItemsWithFallback(parsed, fallbackItems) { if (!parsed || typeof parsed !== "object") { return { @@ -716,8 +954,11 @@ export function isNip04EncryptedWatchHistoryEvent(pointerEvent, ciphertext) { return false; } const ivIndex = normalizedCiphertext.indexOf("?iv="); - const baseSegment = ivIndex >= 0 ? normalizedCiphertext.slice(0, ivIndex) : normalizedCiphertext; - const ivSegment = ivIndex >= 0 ? normalizedCiphertext.slice(ivIndex + 4) : ""; + if (ivIndex < 0) { + return false; + } + const baseSegment = normalizedCiphertext.slice(0, ivIndex); + const ivSegment = normalizedCiphertext.slice(ivIndex + 4); const base64Regex = /^[A-Za-z0-9+/]+={0,2}$/; if (!baseSegment || !base64Regex.test(baseSegment)) { return false; @@ -1149,12 +1390,14 @@ class WatchHistoryManager { normalizedLogged === actorKey && signer && typeof signer.signEvent === "function"; - const useActiveSignerEncrypt = - canUseActiveSignerSign && signer && typeof signer.nip04Encrypt === "function"; + const signerSupportsEncryption = + canUseActiveSignerSign && + signer && + (typeof signer.nip04Encrypt === "function" || typeof signer.nip44Encrypt === "function"); const activeSigner = canUseActiveSignerSign ? signer : null; - const encryptionSigner = useActiveSignerEncrypt ? signer : null; + const encryptionSigner = signerSupportsEncryption ? signer : null; if ( - (canUseActiveSignerSign || useActiveSignerEncrypt) && + (canUseActiveSignerSign || signerSupportsEncryption) && this.deps.shouldRequestExtensionPermissions?.(signer) ) { await this.deps.ensureExtensionPermissions?.(DEFAULT_NIP07_PERMISSION_METHODS); @@ -1225,67 +1468,161 @@ class WatchHistoryManager { source: options.source || "unknown", }); const createdAtBase = Math.max(Math.floor(Date.now() / 1000), this.lastCreatedAt + 1); - let cachedNip04Tools = null; - const ensureNip04Tools = async () => { - if (cachedNip04Tools) { - return cachedNip04Tools; + const toolkitCache = { current: null }; + const encryptionCandidates = []; + const registerEncryptor = (scheme, handler, source) => { + if (!scheme || typeof handler !== "function") { + return; } - - const ensureToolkit = - typeof this.deps.ensureNostrTools === "function" - ? this.deps.ensureNostrTools - : ensureNostrTools; - if (ensureToolkit) { - try { - const ensured = await ensureToolkit(); - if ( - ensured?.nip04 && - typeof ensured.nip04.encrypt === "function" - ) { - cachedNip04Tools = ensured; - return cachedNip04Tools; - } - } catch (error) { - devLogger.warn( - "[nostr] Failed to resolve nostr-tools for watch history:", - error, - ); - } - } - - const readCachedToolkit = - typeof this.deps.getCachedNostrTools === "function" - ? this.deps.getCachedNostrTools - : getCachedNostrTools; - if (readCachedToolkit) { - try { - const cached = await readCachedToolkit(); - if ( - cached?.nip04 && - typeof cached.nip04.encrypt === "function" - ) { - cachedNip04Tools = cached; - return cachedNip04Tools; - } - } catch (error) { - devLogger.warn( - "[nostr] Failed to read cached nostr-tools for watch history:", - error, - ); - } - } - - return null; + encryptionCandidates.push({ + scheme, + handler, + source: source || "unknown", + }); }; - const encryptChunk = async (plaintext) => { - if (encryptionSigner) { - return encryptionSigner.nip04Encrypt(actorPubkey, plaintext); + + if (encryptionSigner) { + if (typeof encryptionSigner.nip44Encrypt === "function") { + registerEncryptor( + "nip44_v2", + (plaintext) => encryptionSigner.nip44Encrypt(actorPubkey, plaintext), + "active-signer", + ); + registerEncryptor( + "nip44", + (plaintext) => encryptionSigner.nip44Encrypt(actorPubkey, plaintext), + "active-signer", + ); } - const tools = await ensureNip04Tools(); - if (!tools?.nip04 || typeof tools.nip04.encrypt !== "function") { - throw new Error("nip04-unavailable"); + if (typeof encryptionSigner.nip04Encrypt === "function") { + registerEncryptor( + "nip04", + (plaintext) => encryptionSigner.nip04Encrypt(actorPubkey, plaintext), + "active-signer", + ); } - return tools.nip04.encrypt(privateKey, actorPubkey, plaintext); + } + + const ensureSessionEncryptors = async () => { + if (!privateKey) { + return; + } + const tools = await resolveNostrToolkit(this.deps, toolkitCache); + if (!tools) { + return; + } + const suite = createNip44CipherSuite(tools, privateKey, actorKey); + if (suite?.v2?.encrypt) { + registerEncryptor( + "nip44_v2", + (plaintext) => suite.v2.encrypt(plaintext), + "session-nip44_v2", + ); + registerEncryptor( + "nip44", + (plaintext) => suite.v2.encrypt(plaintext), + "session-nip44_v2", + ); + } + if (suite?.legacy?.encrypt) { + registerEncryptor( + "nip44", + (plaintext) => suite.legacy.encrypt(plaintext), + "session-nip44", + ); + } + if (tools?.nip04 && typeof tools.nip04.encrypt === "function") { + registerEncryptor( + "nip04", + (plaintext) => tools.nip04.encrypt(privateKey, actorPubkey, plaintext), + "session-nip04", + ); + } + }; + + await ensureSessionEncryptors(); + + if (!encryptionCandidates.length) { + userLogger.warn( + "[nostr] No encryption strategies available to publish watch history.", + { + actor: actorKey, + snapshotId, + }, + ); + return { ok: false, error: "encryption-unavailable", retryable: false }; + } + + const candidateIdentity = (candidate) => + `${candidate.scheme}:${candidate.source || "unknown"}`; + const failedEncryptionCandidates = new Set(); + const encryptionAttemptErrors = []; + let selectedEncryptor = null; + + const tryEncryptWithCandidate = async (candidate, plaintext, context = {}) => { + const details = { + actor: actorKey, + snapshotId, + chunkIndex: context.chunkIndex ?? null, + chunkIdentifier: context.chunkIdentifier ?? null, + scheme: candidate.scheme, + source: candidate.source, + }; + try { + devLogger.info("[nostr] Attempting to encrypt watch history chunk.", details); + const encrypted = await candidate.handler(plaintext); + if (typeof encrypted !== "string" || !encrypted) { + throw new Error("empty-ciphertext"); + } + devLogger.info("[nostr] Encrypted watch history chunk.", details); + return { ciphertext: encrypted, scheme: candidate.scheme, candidate }; + } catch (error) { + devLogger.warn("[nostr] Failed to encrypt watch history chunk with candidate.", { + ...details, + error: error?.message || error, + }); + failedEncryptionCandidates.add(candidateIdentity(candidate)); + encryptionAttemptErrors.push({ + scheme: candidate.scheme, + source: candidate.source, + error, + context: { + snapshotId, + chunkIndex: context.chunkIndex ?? null, + chunkIdentifier: context.chunkIdentifier ?? null, + }, + }); + return null; + } + }; + + const encryptChunkPayload = async (plaintext, context = {}) => { + if ( + selectedEncryptor && + !failedEncryptionCandidates.has(candidateIdentity(selectedEncryptor)) + ) { + const reuseResult = await tryEncryptWithCandidate( + selectedEncryptor, + plaintext, + context, + ); + if (reuseResult) { + return reuseResult; + } + selectedEncryptor = null; + } + for (const candidate of encryptionCandidates) { + const identity = candidateIdentity(candidate); + if (failedEncryptionCandidates.has(identity)) { + continue; + } + const result = await tryEncryptWithCandidate(candidate, plaintext, context); + if (result) { + selectedEncryptor = candidate; + return result; + } + } + throw new Error("encryption-unavailable"); }; const signEvent = async (event) => { if (activeSigner) { @@ -1366,14 +1703,41 @@ class WatchHistoryManager { totalChunks: chunks.length, items: chunkItems, }); + const chunkIdentifier = `${snapshotId}:${index}`; let ciphertext = ""; + let encryptionScheme = ""; try { - ciphertext = await encryptChunk(plaintext); + const encryptionResult = await encryptChunkPayload(plaintext, { + chunkIndex: index, + chunkIdentifier, + }); + ciphertext = encryptionResult?.ciphertext || ""; + encryptionScheme = encryptionResult?.scheme || ""; } catch (error) { - userLogger.warn("[nostr] Failed to encrypt watch history chunk:", error); + userLogger.warn("[nostr] Failed to encrypt watch history chunk:", { + actor: actorKey, + snapshotId, + chunkIndex: index, + chunkIdentifier, + error: error?.message || error, + attempts: encryptionAttemptErrors.map((entry) => ({ + scheme: entry.scheme, + source: entry.source, + error: entry.error?.message || entry.error, + })), + }); + return { ok: false, error: "encryption-failed", retryable: false }; + } + if (!ciphertext) { + userLogger.warn("[nostr] Encryption produced an empty payload for watch history chunk.", { + actor: actorKey, + snapshotId, + chunkIndex: index, + chunkIdentifier, + scheme: encryptionScheme || null, + }); return { ok: false, error: "encryption-failed", retryable: false }; } - const chunkIdentifier = `${snapshotId}:${index}`; const event = buildWatchHistoryChunkEvent({ pubkey: actorPubkey, created_at: createdAtCursor, @@ -1383,6 +1747,7 @@ class WatchHistoryManager { totalChunks: chunks.length, pointerTags, content: ciphertext, + encryption: encryptionScheme, }); createdAtCursor += 1; let signedEvent; @@ -1735,7 +2100,7 @@ class WatchHistoryManager { normalizedLogged && normalizedLogged === actorKey && signer && - typeof signer.nip04Decrypt === "function"; + (typeof signer.nip04Decrypt === "function" || typeof signer.nip44Decrypt === "function"); const decryptSigner = canUseActiveSignerDecrypt ? signer : null; if (decryptSigner && this.deps.shouldRequestExtensionPermissions?.(decryptSigner)) { await this.deps.ensureExtensionPermissions?.(DEFAULT_NIP07_PERMISSION_METHODS); @@ -1976,79 +2341,95 @@ class WatchHistoryManager { } const decryptErrors = []; const collectedItems = []; - const ensureDecryptTools = async () => { - const tools = await ensureNostrTools(); - if (tools?.nip04 && typeof tools.nip04.decrypt === "function") { - devLogger.info("[nostr] Loaded nostr-tools nip04 helpers for watch history decryption."); - return tools; + const toolkitCache = { current: null }; + const decryptorCandidates = new Map(); + const registerDecryptor = (scheme, handler, source) => { + if (!scheme || typeof handler !== "function") { + return; } - userLogger.warn( - "[nostr] Unable to load nostr-tools nip04 helpers for watch history decryption.", - ); - return null; + const existing = decryptorCandidates.get(scheme) || []; + existing.push({ handler, source: source || "unknown" }); + decryptorCandidates.set(scheme, existing); }; - const decryptChunk = async (ciphertext, context = {}) => { - if (decryptSigner) { - devLogger.info("[nostr] Using active signer to decrypt watch history chunk.", { - actorKey, - chunkIdentifier: context.chunkIdentifier ?? null, - eventId: context.eventId ?? null, - }); - const plaintext = await decryptSigner.nip04Decrypt(actorKey, ciphertext); - devLogger.info("[nostr] Successfully decrypted watch history chunk via active signer.", { - actorKey, - chunkIdentifier: context.chunkIdentifier ?? null, - eventId: context.eventId ?? null, - }); - return plaintext; - } - const session = this.deps.getSessionActor?.(); - if (!session || session.pubkey !== actorKey) { - devLogger.info( - "[nostr] Session actor mismatch while decrypting watch history chunk. Ensuring session actor matches requested key.", + + if (decryptSigner) { + if (typeof decryptSigner.nip44Decrypt === "function") { + registerDecryptor( + "nip44_v2", + (payload) => decryptSigner.nip44Decrypt(actorKey, payload), + "active-signer", ); - const ensured = await this.deps.ensureSessionActor?.(); - if (normalizeActorKey(ensured) !== actorKey) { - throw new Error("session-actor-mismatch"); + registerDecryptor( + "nip44", + (payload) => decryptSigner.nip44Decrypt(actorKey, payload), + "active-signer", + ); + } + if (typeof decryptSigner.nip04Decrypt === "function") { + registerDecryptor( + "nip04", + (payload) => decryptSigner.nip04Decrypt(actorKey, payload), + "active-signer", + ); + } + } + + const ensureSessionDecryptors = async () => { + try { + let session = this.deps.getSessionActor?.(); + if (!session || session.pubkey !== actorKey || !session.privateKey) { + const ensured = await this.deps.ensureSessionActor?.(); + if (normalizeActorKey(ensured) !== actorKey) { + throw new Error("session-actor-mismatch"); + } + session = this.deps.getSessionActor?.(); } - } - const refreshedSession = this.deps.getSessionActor?.(); - if (!refreshedSession || refreshedSession.pubkey !== actorKey) { - throw new Error("session-actor-missing"); - } - const tools = await ensureDecryptTools(); - if (!tools?.nip04 || typeof tools.nip04.decrypt !== "function") { - userLogger.warn( - "[nostr] Unable to decrypt watch history chunk because nip04 helpers are unavailable.", - { - actorKey, - chunkIdentifier: context.chunkIdentifier ?? null, - eventId: context.eventId ?? null, - }, - ); - throw new Error("nip04-unavailable"); - } - devLogger.info( - "[nostr] Using session actor private key to decrypt watch history chunk.", - { + if (!session || session.pubkey !== actorKey) { + throw new Error("session-actor-missing"); + } + if (!session.privateKey) { + throw new Error("missing-session-key"); + } + const tools = await resolveNostrToolkit(this.deps, toolkitCache); + if (!tools) { + throw new Error("nostr-tools-missing"); + } + const suite = createNip44CipherSuite(tools, session.privateKey, actorKey); + if (suite?.v2?.decrypt) { + registerDecryptor( + "nip44_v2", + async (payload) => suite.v2.decrypt(payload), + "session-nip44_v2", + ); + registerDecryptor( + "nip44", + async (payload) => suite.v2.decrypt(payload), + "session-nip44_v2", + ); + } + if (suite?.legacy?.decrypt) { + registerDecryptor( + "nip44", + async (payload) => suite.legacy.decrypt(payload), + "session-nip44", + ); + } + if (tools?.nip04 && typeof tools.nip04.decrypt === "function") { + registerDecryptor( + "nip04", + async (payload) => tools.nip04.decrypt(session.privateKey, actorKey, payload), + "session-nip04", + ); + } + } catch (error) { + devLogger.warn("[nostr] Unable to register session decryptors for watch history.", { actorKey, - chunkIdentifier: context.chunkIdentifier ?? null, - eventId: context.eventId ?? null, - sessionActor: refreshedSession.pubkey ?? null, - }, - ); - const plaintext = await tools.nip04.decrypt( - refreshedSession.privateKey, - actorKey, - ciphertext, - ); - devLogger.info("[nostr] Successfully decrypted watch history chunk via session actor key.", { - actorKey, - chunkIdentifier: context.chunkIdentifier ?? null, - eventId: context.eventId ?? null, - }); - return plaintext; + error: error?.message || error, + }); + } }; + + await ensureSessionDecryptors(); const chunkCount = latestChunks.size || chunkIdentifiers.length || 0; const chunkKeys = chunkIdentifiers.length ? chunkIdentifiers @@ -2061,65 +2442,119 @@ class WatchHistoryManager { const fallbackPointers = extractPointerItemsFromEvent(event); const ciphertext = typeof event.content === "string" ? event.content : ""; const ciphertextPreview = ciphertext.slice(0, 32); - let payload; const chunkContext = { chunkIdentifier: identifier, eventId: event.id ?? null, }; - if (isNip04EncryptedWatchHistoryEvent(event, ciphertext)) { - devLogger.info("[nostr] Watch history chunk is marked as NIP-04 encrypted. Beginning decrypt flow.", { - actorKey, - ...chunkContext, - }); - try { - const plaintext = await decryptChunk(ciphertext, chunkContext); - devLogger.info("[nostr] Decrypted watch history chunk. Parsing plaintext payload.", { - actorKey, - ...chunkContext, - plaintextPreview: typeof plaintext === "string" ? plaintext.slice(0, 64) : null, - expectedPlaintextFormat: - "JSON string with { version, items, snapshot, chunkIndex, totalChunks }", - }); - payload = parseWatchHistoryContentWithFallback( - plaintext, - fallbackPointers, - { - version: 0, - items: fallbackPointers, - snapshot: snapshotId, - chunkIndex: 0, - totalChunks: chunkCount || 1, - }, - ); - } catch (error) { - decryptErrors.push(error); - userLogger.error( - "[nostr] Decrypt failed for watch history chunk. Falling back to pointer items.", - { + const availableSchemes = Array.from(decryptorCandidates.keys()); + const decryptOrder = determineWatchHistoryDecryptionOrder( + event, + ciphertext, + availableSchemes, + ); + let plaintext = null; + let usedScheme = ""; + let usedSource = ""; + const attemptFailures = []; + + if (decryptOrder.length) { + outer: for (const scheme of decryptOrder) { + const candidates = decryptorCandidates.get(scheme) || []; + for (const candidate of candidates) { + const details = { actorKey, ...chunkContext, - error: error?.message || error, - ciphertextPreview, - fallbackPointerCount: Array.isArray(fallbackPointers) - ? fallbackPointers.length - : 0, - expectedPlaintextFormat: - "JSON string with { version, items, snapshot, chunkIndex, totalChunks }", - }, - ); - payload = { - version: 0, - items: fallbackPointers, - }; + scheme, + source: candidate.source, + }; + try { + devLogger.info("[nostr] Attempting to decrypt watch history chunk.", details); + const result = await candidate.handler(ciphertext, chunkContext); + if (typeof result !== "string") { + throw new Error("invalid-plaintext"); + } + devLogger.info("[nostr] Successfully decrypted watch history chunk.", details); + plaintext = result; + usedScheme = scheme; + usedSource = candidate.source || ""; + break outer; + } catch (error) { + devLogger.warn("[nostr] Failed to decrypt watch history chunk with candidate.", { + ...details, + error: error?.message || error, + }); + attemptFailures.push({ scheme, source: candidate.source, error }); + } + } } - } else { - devLogger.info("[nostr] Watch history chunk is plaintext. Attempting to parse expected payload format.", { + } + + const encryptionHints = extractWatchHistoryEncryptionHints(event, ciphertext); + const isEncryptedChunk = + encryptionHints.length > 0 || + (!looksLikeJsonStructure(ciphertext) && Boolean(ciphertext.trim())); + + let payload; + if (plaintext !== null) { + devLogger.info("[nostr] Decrypted watch history chunk. Parsing plaintext payload.", { actorKey, ...chunkContext, - ciphertextPreview, + scheme: usedScheme || null, + source: usedSource || null, + plaintextPreview: typeof plaintext === "string" ? plaintext.slice(0, 64) : null, expectedPlaintextFormat: "JSON string with { version, items, snapshot, chunkIndex, totalChunks }", }); + payload = parseWatchHistoryContentWithFallback( + plaintext, + fallbackPointers, + { + version: 0, + items: fallbackPointers, + snapshot: snapshotId, + chunkIndex: 0, + totalChunks: chunkCount || 1, + }, + ); + } else if (isEncryptedChunk) { + decryptErrors.push({ + chunkIdentifier: identifier, + eventId: event.id ?? null, + attempts: attemptFailures, + }); + userLogger.error( + "[nostr] Decrypt failed for watch history chunk. Falling back to pointer items.", + { + actorKey, + ...chunkContext, + attempts: attemptFailures.map((entry) => ({ + scheme: entry.scheme, + source: entry.source, + error: entry.error?.message || entry.error, + })), + ciphertextPreview, + fallbackPointerCount: Array.isArray(fallbackPointers) + ? fallbackPointers.length + : 0, + expectedPlaintextFormat: + "JSON string with { version, items, snapshot, chunkIndex, totalChunks }", + }, + ); + payload = { + version: 0, + items: fallbackPointers, + }; + } else { + devLogger.info( + "[nostr] Watch history chunk is plaintext. Attempting to parse expected payload format.", + { + actorKey, + ...chunkContext, + ciphertextPreview, + expectedPlaintextFormat: + "JSON string with { version, items, snapshot, chunkIndex, totalChunks }", + }, + ); payload = parseWatchHistoryContentWithFallback( ciphertext, fallbackPointers, @@ -2132,6 +2567,7 @@ class WatchHistoryManager { }, ); } + if (Array.isArray(payload?.items)) { collectedItems.push(...payload.items); } diff --git a/js/nostrEventSchemas.js b/js/nostrEventSchemas.js index f619fd7f..dfd2fbaf 100644 --- a/js/nostrEventSchemas.js +++ b/js/nostrEventSchemas.js @@ -1,4 +1,5 @@ import { devLogger } from "./utils/logger.js"; +import { decodeNpubToHex } from "./nostr/nip46Client.js"; import { ADMIN_LIST_NAMESPACE, ADMIN_COMMUNITY_BLACKLIST_SOURCES, @@ -45,6 +46,101 @@ const DEFAULT_APPEND_TAGS = []; let cachedUtf8Encoder = null; +const ADDITIONAL_POINTER_TAGS = new Set(["p", "e"]); +const HEX_32_BYTE_REGEX = /^[0-9a-f]{64}$/i; + +function normalizePointerIdentifier(value) { + if (typeof value !== "string") { + return ""; + } + + const trimmed = value.trim(); + if (!trimmed) { + return ""; + } + + if (HEX_32_BYTE_REGEX.test(trimmed)) { + return trimmed.toLowerCase(); + } + + const decoded = decodeNpubToHex(trimmed); + if (decoded && HEX_32_BYTE_REGEX.test(decoded)) { + return decoded.toLowerCase(); + } + + return ""; +} + +function normalizeTagSlotValue(value) { + if (typeof value === "string") { + const trimmed = value.trim(); + return trimmed; + } + + if (typeof value === "number") { + if (!Number.isFinite(value)) { + return ""; + } + return String(value); + } + + if (value === null || value === undefined) { + return ""; + } + + return ""; +} + +export function sanitizeAdditionalTags(additionalTags) { + if (!Array.isArray(additionalTags) || !additionalTags.length) { + return []; + } + + const sanitized = []; + + additionalTags.forEach((tag) => { + if (!Array.isArray(tag) || tag.length < 2) { + return; + } + + const rawName = tag[0]; + if (typeof rawName !== "string") { + return; + } + + const tagName = rawName.trim(); + if (!tagName) { + return; + } + + const lowerName = tagName.toLowerCase(); + let primaryValue = ""; + + if (ADDITIONAL_POINTER_TAGS.has(lowerName)) { + primaryValue = normalizePointerIdentifier(tag[1]); + } else { + primaryValue = normalizeTagSlotValue(tag[1]); + } + + if (!primaryValue) { + return; + } + + const sanitizedTag = [tagName, primaryValue]; + + for (let index = 2; index < tag.length; index += 1) { + const extraValue = normalizeTagSlotValue(tag[index]); + if (extraValue) { + sanitizedTag.push(extraValue); + } + } + + sanitized.push(sanitizedTag); + }); + + return sanitized; +} + function ensureValidUtf8Content(value) { let normalized = ""; if (typeof value === "string") { @@ -238,11 +334,17 @@ const BASE_SCHEMAS = { [NOTE_TYPES.VIDEO_COMMENT]: { type: NOTE_TYPES.VIDEO_COMMENT, label: "Video comment", - kind: 1, + kind: 1111, videoEventTagName: "e", videoDefinitionTagName: "a", parentCommentTagName: "e", - participantTagName: "p", + parentAuthorTagName: "p", + rootEventPointerTagName: "E", + rootDefinitionPointerTagName: "A", + rootIdentifierPointerTagName: "I", + rootKindTagName: "K", + rootAuthorTagName: "P", + parentKindTagName: "k", appendTags: DEFAULT_APPEND_TAGS, content: { format: "text", @@ -274,14 +376,14 @@ const BASE_SCHEMAS = { identifierTag: { name: "d", }, - encryptionTag: { name: "encrypted", value: "nip04" }, + encryptionTag: { name: "encrypted", values: ["nip44_v2", "nip44", "nip04"] }, snapshotTagName: "snapshot", chunkTagName: "chunk", headTag: { name: "head", value: "1" }, headTagIndex: 2, appendTags: DEFAULT_APPEND_TAGS, content: { - format: "nip04-json", + format: "encrypted-json", description: "Encrypted JSON payload containing chunked watch history entries.", }, @@ -289,29 +391,31 @@ const BASE_SCHEMAS = { [NOTE_TYPES.SUBSCRIPTION_LIST]: { type: NOTE_TYPES.SUBSCRIPTION_LIST, label: "Subscription list", - kind: 30002, + kind: 30000, identifierTag: { name: "d", value: SUBSCRIPTION_LIST_IDENTIFIER, }, appendTags: DEFAULT_APPEND_TAGS, content: { - format: "nip04-json", - description: "Encrypted JSON: { subPubkeys: string[] }.", + format: "encrypted-tag-list", + description: + "NIP-04/NIP-44 encrypted JSON array of NIP-51 tag tuples (e.g., [['p', <hex>], …]).", }, }, [NOTE_TYPES.USER_BLOCK_LIST]: { type: NOTE_TYPES.USER_BLOCK_LIST, label: "User block list", - kind: 30002, + kind: 10000, identifierTag: { name: "d", value: BLOCK_LIST_IDENTIFIER, }, appendTags: DEFAULT_APPEND_TAGS, content: { - format: "nip04-json", - description: "Encrypted JSON: { blockedPubkeys: string[] }.", + format: "encrypted-tag-list", + description: + "NIP-04/NIP-44 encrypted JSON array of mute tags per NIP-51 (e.g., [['p', <hex>], …]).", }, }, [NOTE_TYPES.HASHTAG_PREFERENCES]: { @@ -489,6 +593,99 @@ function collectPointerTags(schema, { return normalized; } +function mergePointerTags(pointerTags = []) { + if (!Array.isArray(pointerTags) || pointerTags.length === 0) { + return []; + } + + const merged = []; + const pointerIndexByKey = new Map(); + + const toTrimmedString = (value) => { + if (typeof value === "string") { + return value.trim(); + } + if (value === undefined || value === null) { + return ""; + } + return String(value).trim(); + }; + + pointerTags.forEach((tag) => { + if (!Array.isArray(tag) || tag.length < 2) { + return; + } + + const normalizedType = toTrimmedString(tag[0]); + if (!normalizedType) { + return; + } + + const canonicalType = + normalizedType === "a" ? "a" : normalizedType === "e" ? "e" : normalizedType; + + const normalizedValue = toTrimmedString(tag[1]); + if (!normalizedValue) { + return; + } + + const sanitizedTag = [canonicalType, normalizedValue]; + for (let index = 2; index < tag.length; index += 1) { + const extra = toTrimmedString(tag[index]); + if (extra) { + sanitizedTag.push(extra); + } + } + + if (canonicalType !== "a" && canonicalType !== "e") { + merged.push(sanitizedTag); + return; + } + + const dedupeKey = `${canonicalType}:${normalizedValue.toLowerCase()}`; + const relayHint = + sanitizedTag.length > 2 && typeof sanitizedTag[2] === "string" + ? sanitizedTag[2].trim() + : ""; + + if (!pointerIndexByKey.has(dedupeKey)) { + if (relayHint && sanitizedTag.length > 2) { + sanitizedTag[2] = relayHint; + } + const index = merged.length; + merged.push(sanitizedTag); + pointerIndexByKey.set(dedupeKey, { index, relay: relayHint }); + return; + } + + const existingEntry = pointerIndexByKey.get(dedupeKey); + const existingTag = merged[existingEntry.index]; + const existingRelay = + existingTag.length > 2 && typeof existingTag[2] === "string" + ? existingTag[2].trim() + : ""; + const hasExistingRelay = Boolean(existingRelay); + const hasNewRelay = Boolean(relayHint); + + if ( + (!hasExistingRelay && hasNewRelay) || + (hasExistingRelay && hasNewRelay && existingRelay !== relayHint) + ) { + const replacement = sanitizedTag.slice(); + if (relayHint && replacement.length > 2) { + replacement[2] = relayHint; + } + merged[existingEntry.index] = replacement; + pointerIndexByKey.set(dedupeKey, { + index: existingEntry.index, + relay: relayHint, + }); + } + }); + + return merged; +} + export function buildVideoPostEvent({ pubkey, created_at, @@ -505,12 +702,9 @@ export function buildVideoPostEvent({ tags.push([schema.identifierTag.name, dTagValue]); } appendSchemaTags(tags, schema); - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); - } - }); + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); } return { @@ -556,18 +750,23 @@ export function buildRepostEvent({ addressRelay = "", authorPubkey = "", additionalTags = [], + repostKind, + targetKind, + targetEvent = null, + serializedEvent = "", }) { const schema = getNostrEventSchema(NOTE_TYPES.REPOST); const tags = []; const normalizedEventId = typeof eventId === "string" ? eventId.trim() : ""; - const normalizedEventRelay = typeof eventRelay === "string" ? eventRelay.trim() : ""; + const normalizedEventRelay = + typeof eventRelay === "string" ? eventRelay.trim() : ""; + if (normalizedEventId) { - if (normalizedEventRelay) { - tags.push(["e", normalizedEventId, normalizedEventRelay]); - } else { - tags.push(["e", normalizedEventId]); + if (!normalizedEventRelay) { + throw new Error("missing-event-relay"); } + tags.push(["e", normalizedEventId, normalizedEventRelay]); } const normalizedAddress = typeof address === "string" ? address.trim() : ""; @@ -587,21 +786,72 @@ export function buildRepostEvent({ } appendSchemaTags(tags, schema); + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); + } - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); + const normalizedRepostKind = + Number.isFinite(repostKind) && repostKind !== null + ? Math.floor(repostKind) + : null; + const normalizedTargetKind = + Number.isFinite(targetKind) && targetKind !== null + ? Math.floor(targetKind) + : null; + const resolvedKind = (() => { + if (normalizedRepostKind) { + return normalizedRepostKind; + } + if (normalizedTargetKind !== null) { + return normalizedTargetKind === 1 ? schema?.kind ?? 6 : 16; + } + return schema?.kind ?? 6; + })(); + + if (resolvedKind === 16 && normalizedTargetKind !== null) { + tags.push(["k", String(normalizedTargetKind)]); + } + + const normalizedSerializedEvent = + typeof serializedEvent === "string" ? serializedEvent : ""; + let normalizedTargetEvent = + targetEvent && typeof targetEvent === "object" ? targetEvent : null; + + if (!normalizedTargetEvent && normalizedSerializedEvent) { + try { + normalizedTargetEvent = JSON.parse(normalizedSerializedEvent); + } catch (error) { + void error; + } + } + + const hasProtectedTag = Array.isArray(normalizedTargetEvent?.tags) + ? normalizedTargetEvent.tags.some( + (tag) => Array.isArray(tag) && tag.length && tag[0] === "-", + ) + : false; + + let content = ""; + + if (!hasProtectedTag) { + if (normalizedSerializedEvent) { + content = normalizedSerializedEvent; + } else if (normalizedTargetEvent) { + try { + content = JSON.stringify(normalizedTargetEvent); + } catch (error) { + void error; } - }); + } } return { - kind: schema?.kind ?? 6, + kind: resolvedKind, pubkey, created_at, tags, - content: "", + content, }; } @@ -661,12 +911,9 @@ export function buildRelayListEvent({ appendSchemaTags(tags, schema); - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); - } - }); + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); } return { @@ -703,12 +950,9 @@ export function buildViewEvent({ normalizedPointerTags.forEach((tag) => { tags.push(tag); }); - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); - } - }); + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); } if (dedupeTag && schema?.identifierTag?.name) { @@ -760,8 +1004,11 @@ export function buildReactionEvent({ pointerTag, pointerTags, }); - normalizedPointerTags.forEach((tag) => { - tags.push(tag); + const mergedPointerTags = mergePointerTags(normalizedPointerTags); + mergedPointerTags.forEach((tag) => { + if (Array.isArray(tag) && tag.length >= 2) { + tags.push(tag); + } }); const resolvePointerDetails = (pointerCandidate) => { @@ -802,7 +1049,7 @@ export function buildReactionEvent({ return explicitPointer; } - const pointerTagEntry = normalizedPointerTags.find( + const pointerTagEntry = mergedPointerTags.find( (tag) => Array.isArray(tag) && tag.length >= 2 && (tag[0] === "a" || tag[0] === "e") ); if (!pointerTagEntry) { @@ -851,12 +1098,9 @@ export function buildReactionEvent({ } } - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); - } - }); + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); } appendSchemaTags(tags, schema); @@ -879,92 +1123,216 @@ export function buildCommentEvent({ videoEventRelay = "", videoDefinitionAddress = "", videoDefinitionRelay = "", + rootIdentifier = "", + rootIdentifierRelay = "", parentCommentId = "", parentCommentRelay = "", threadParticipantPubkey = "", threadParticipantRelay = "", + rootKind, + rootAuthorPubkey = "", + rootAuthorRelay = "", + parentKind, + parentAuthorPubkey = "", + parentAuthorRelay = "", + parentIdentifier = "", + parentIdentifierRelay = "", additionalTags = [], content = "", }) { const schema = getNostrEventSchema(NOTE_TYPES.VIDEO_COMMENT); const tags = []; - const videoEventTagName = schema?.videoEventTagName || "e"; - const normalizedVideoEventId = - typeof videoEventId === "string" ? videoEventId.trim() : ""; - const normalizedVideoEventRelay = - typeof videoEventRelay === "string" ? videoEventRelay.trim() : ""; - if (videoEventTagName && normalizedVideoEventId) { - if (normalizedVideoEventRelay) { - tags.push([videoEventTagName, normalizedVideoEventId, normalizedVideoEventRelay]); - } else { - tags.push([videoEventTagName, normalizedVideoEventId]); + const normalizeString = (value) => + typeof value === "string" ? value.trim() : ""; + + const normalizedVideoEventId = normalizeString(videoEventId); + const normalizedVideoEventRelay = normalizeString(videoEventRelay); + const normalizedVideoDefinitionAddress = normalizeString(videoDefinitionAddress); + const normalizedVideoDefinitionRelay = normalizeString(videoDefinitionRelay); + const normalizedRootIdentifier = normalizeString(rootIdentifier); + const normalizedRootIdentifierRelay = normalizeString(rootIdentifierRelay); + const normalizedParentCommentId = normalizeString(parentCommentId); + const normalizedParentCommentRelay = normalizeString(parentCommentRelay); + const normalizedParentIdentifier = normalizeString(parentIdentifier); + const normalizedParentIdentifierRelay = normalizeString(parentIdentifierRelay); + const normalizedThreadParticipantPubkey = normalizeString( + threadParticipantPubkey, + ); + const normalizedThreadParticipantRelay = normalizeString( + threadParticipantRelay, + ); + + let resolvedRootKind = normalizeString(rootKind); + let resolvedRootAuthorPubkey = normalizeString(rootAuthorPubkey); + let resolvedRootAuthorRelay = normalizeString(rootAuthorRelay); + + if (normalizedVideoDefinitionAddress) { + const definitionSegments = normalizedVideoDefinitionAddress.split(":"); + if (!resolvedRootKind && definitionSegments[0]) { + resolvedRootKind = definitionSegments[0]; + } + if (!resolvedRootAuthorPubkey && definitionSegments[1]) { + resolvedRootAuthorPubkey = definitionSegments[1]; + } + if (!resolvedRootAuthorRelay && normalizedVideoDefinitionRelay) { + resolvedRootAuthorRelay = normalizedVideoDefinitionRelay; } } + let resolvedParentAuthorPubkey = normalizeString(parentAuthorPubkey); + if (!resolvedParentAuthorPubkey) { + resolvedParentAuthorPubkey = normalizedThreadParticipantPubkey; + } + + let resolvedParentAuthorRelay = normalizeString(parentAuthorRelay); + if (!resolvedParentAuthorRelay) { + resolvedParentAuthorRelay = normalizedThreadParticipantRelay; + } + + if (!resolvedRootAuthorPubkey && !normalizedParentCommentId) { + resolvedRootAuthorPubkey = resolvedParentAuthorPubkey; + } + if (!resolvedRootAuthorRelay && !normalizedParentCommentId) { + resolvedRootAuthorRelay = resolvedParentAuthorRelay; + } + + if (!resolvedParentAuthorPubkey && !normalizedParentCommentId) { + resolvedParentAuthorPubkey = resolvedRootAuthorPubkey; + } + if (!resolvedParentAuthorRelay && !normalizedParentCommentId) { + resolvedParentAuthorRelay = resolvedRootAuthorRelay; + } + + let resolvedParentKind = normalizeString(parentKind); + if (!resolvedParentKind) { + if (normalizedParentCommentId) { + resolvedParentKind = String(schema?.kind ?? 1111); + } else if (resolvedRootKind) { + resolvedParentKind = resolvedRootKind; + } + } + + if (!resolvedRootKind) { + resolvedRootKind = resolvedParentKind; + } + + const rootDefinitionPointerTagName = schema?.rootDefinitionPointerTagName || "A"; + const rootEventPointerTagName = schema?.rootEventPointerTagName || "E"; + const rootIdentifierPointerTagName = schema?.rootIdentifierPointerTagName || "I"; + const rootKindTagName = schema?.rootKindTagName || "K"; + const rootAuthorTagName = schema?.rootAuthorTagName || "P"; const videoDefinitionTagName = schema?.videoDefinitionTagName || "a"; - const normalizedVideoDefinitionAddress = - typeof videoDefinitionAddress === "string" - ? videoDefinitionAddress.trim() - : ""; - const normalizedVideoDefinitionRelay = - typeof videoDefinitionRelay === "string" ? videoDefinitionRelay.trim() : ""; - if (videoDefinitionTagName && normalizedVideoDefinitionAddress) { - if (normalizedVideoDefinitionRelay) { - tags.push([ - videoDefinitionTagName, - normalizedVideoDefinitionAddress, - normalizedVideoDefinitionRelay, - ]); - } else { - tags.push([videoDefinitionTagName, normalizedVideoDefinitionAddress]); - } - } - + const videoEventTagName = schema?.videoEventTagName || "e"; const parentCommentTagName = schema?.parentCommentTagName || "e"; - const normalizedParentCommentId = - typeof parentCommentId === "string" ? parentCommentId.trim() : ""; - const normalizedParentCommentRelay = - typeof parentCommentRelay === "string" ? parentCommentRelay.trim() : ""; + const parentAuthorTagName = schema?.parentAuthorTagName || "p"; + const parentKindTagName = schema?.parentKindTagName || "k"; + + const appendPointerTag = (tagName, value, relay, authorHint) => { + if (!tagName || !value) { + return; + } + const tag = [tagName, value]; + if (relay) { + tag.push(relay); + } + if (authorHint) { + tag.push(authorHint); + } + tags.push(tag); + }; + + if (normalizedRootIdentifier) { + appendPointerTag( + rootIdentifierPointerTagName, + normalizedRootIdentifier, + normalizedRootIdentifierRelay, + ); + } else if (normalizedVideoDefinitionAddress) { + appendPointerTag( + rootDefinitionPointerTagName, + normalizedVideoDefinitionAddress, + normalizedVideoDefinitionRelay, + ); + } else if (normalizedVideoEventId) { + appendPointerTag( + rootEventPointerTagName, + normalizedVideoEventId, + normalizedVideoEventRelay, + resolvedRootAuthorPubkey, + ); + } + + if (rootKindTagName && resolvedRootKind) { + tags.push([rootKindTagName, resolvedRootKind]); + } + + if (rootAuthorTagName && resolvedRootAuthorPubkey) { + if (resolvedRootAuthorRelay) { + tags.push([rootAuthorTagName, resolvedRootAuthorPubkey, resolvedRootAuthorRelay]); + } else { + tags.push([rootAuthorTagName, resolvedRootAuthorPubkey]); + } + } + + const shouldAppendVideoEventTag = + Boolean(videoEventTagName) && Boolean(normalizedVideoEventId); + + if (shouldAppendVideoEventTag) { + appendPointerTag( + videoEventTagName, + normalizedVideoEventId, + normalizedVideoEventRelay, + ); + } + + if (videoDefinitionTagName && normalizedVideoDefinitionAddress) { + appendPointerTag( + videoDefinitionTagName, + normalizedVideoDefinitionAddress, + normalizedVideoDefinitionRelay, + ); + } + + if (normalizedParentIdentifier) { + appendPointerTag("i", normalizedParentIdentifier, normalizedParentIdentifierRelay); + } + if (parentCommentTagName && normalizedParentCommentId) { - if (normalizedParentCommentRelay) { - tags.push([ - parentCommentTagName, - normalizedParentCommentId, - normalizedParentCommentRelay, - ]); - } else { - tags.push([parentCommentTagName, normalizedParentCommentId]); - } + appendPointerTag( + parentCommentTagName, + normalizedParentCommentId, + normalizedParentCommentRelay, + resolvedParentAuthorPubkey, + ); } - const participantTagName = schema?.participantTagName || "p"; - const normalizedThreadParticipantPubkey = - typeof threadParticipantPubkey === "string" - ? threadParticipantPubkey.trim() - : ""; - const normalizedThreadParticipantRelay = - typeof threadParticipantRelay === "string" - ? threadParticipantRelay.trim() - : ""; - if (participantTagName && normalizedThreadParticipantPubkey) { - if (normalizedThreadParticipantRelay) { - tags.push([ - participantTagName, - normalizedThreadParticipantPubkey, - normalizedThreadParticipantRelay, - ]); - } else { - tags.push([participantTagName, normalizedThreadParticipantPubkey]); - } + if (parentKindTagName && resolvedParentKind) { + tags.push([parentKindTagName, resolvedParentKind]); } - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); + if (parentAuthorTagName && resolvedParentAuthorPubkey) { + const existingParentAuthorTag = tags.find( + (tag) => Array.isArray(tag) && tag[0] === parentAuthorTagName && tag[1] === resolvedParentAuthorPubkey, + ); + if (!existingParentAuthorTag) { + if (resolvedParentAuthorRelay) { + tags.push([parentAuthorTagName, resolvedParentAuthorPubkey, resolvedParentAuthorRelay]); + } else { + tags.push([parentAuthorTagName, resolvedParentAuthorPubkey]); } - }); + } else if (resolvedParentAuthorRelay) { + if (existingParentAuthorTag.length < 3) { + existingParentAuthorTag.push(resolvedParentAuthorRelay); + } else if (existingParentAuthorTag[2] !== resolvedParentAuthorRelay) { + existingParentAuthorTag[2] = resolvedParentAuthorRelay; + } + } + } + + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); } appendSchemaTags(tags, schema); @@ -972,7 +1340,7 @@ export function buildCommentEvent({ const resolvedContent = ensureValidUtf8Content(content); return { - kind: schema?.kind ?? 1, + kind: schema?.kind ?? 1111, pubkey, created_at, tags, @@ -1012,13 +1380,9 @@ export function buildWatchHistoryIndexEvent({ }); appendSchemaTags(tags, schema); - - if (Array.isArray(additionalTags)) { - additionalTags.forEach((tag) => { - if (Array.isArray(tag) && tag.length >= 2) { - tags.push(tag.map((value) => (typeof value === "string" ? value : String(value)))); - } - }); + const sanitizedAdditionalTags = sanitizeAdditionalTags(additionalTags); + if (sanitizedAdditionalTags.length) { + tags.push(...sanitizedAdditionalTags.map((tag) => tag.slice())); } let resolvedContent = content; @@ -1057,6 +1421,7 @@ export function buildWatchHistoryChunkEvent({ pointerTags = [], chunkAddresses = [], content, + encryption, }) { const schema = getNostrEventSchema(NOTE_TYPES.WATCH_HISTORY_CHUNK); const tags = []; @@ -1065,8 +1430,23 @@ export function buildWatchHistoryChunkEvent({ if (identifierName && identifierValue) { tags.push([identifierName, identifierValue]); } - if (schema?.encryptionTag?.name && schema?.encryptionTag?.value) { - tags.push([schema.encryptionTag.name, schema.encryptionTag.value]); + const encryptionTagName = schema?.encryptionTag?.name; + const normalizedOptions = Array.isArray(schema?.encryptionTag?.values) + ? schema.encryptionTag.values + .map((value) => (typeof value === "string" ? value.trim() : "")) + .filter(Boolean) + : []; + const normalizedRequested = typeof encryption === "string" ? encryption.trim() : ""; + let resolvedEncryptionTag = ""; + if (normalizedRequested) { + resolvedEncryptionTag = normalizedRequested; + } else if (typeof schema?.encryptionTag?.value === "string") { + resolvedEncryptionTag = schema.encryptionTag.value; + } else if (normalizedOptions.length) { + [resolvedEncryptionTag] = normalizedOptions; + } + if (encryptionTagName && resolvedEncryptionTag) { + tags.push([encryptionTagName, resolvedEncryptionTag]); } const snapshotTagName = schema?.snapshotTagName; if (snapshotTagName && snapshotId) { @@ -1109,6 +1489,7 @@ export function buildSubscriptionListEvent({ pubkey, created_at, content, + encryption, }) { const schema = getNostrEventSchema(NOTE_TYPES.SUBSCRIPTION_LIST); const tags = []; @@ -1117,9 +1498,14 @@ export function buildSubscriptionListEvent({ if (identifierName && identifierValue) { tags.push([identifierName, identifierValue]); } + const normalizedEncryption = + typeof encryption === "string" ? encryption.trim() : ""; + if (normalizedEncryption) { + tags.push(["encrypted", normalizedEncryption]); + } appendSchemaTags(tags, schema); return { - kind: schema?.kind ?? 30002, + kind: schema?.kind ?? 30000, pubkey, created_at, tags, @@ -1131,6 +1517,7 @@ export function buildBlockListEvent({ pubkey, created_at, content, + encryption, }) { const schema = getNostrEventSchema(NOTE_TYPES.USER_BLOCK_LIST); const tags = []; @@ -1139,9 +1526,14 @@ export function buildBlockListEvent({ if (identifierName && identifierValue) { tags.push([identifierName, identifierValue]); } + const normalizedEncryption = + typeof encryption === "string" ? encryption.trim() : ""; + if (normalizedEncryption) { + tags.push(["encrypted", normalizedEncryption]); + } appendSchemaTags(tags, schema); return { - kind: schema?.kind ?? 30002, + kind: schema?.kind ?? 10000, pubkey, created_at, tags, diff --git a/js/nostrToolsBootstrap.js b/js/nostrToolsBootstrap.js index 813af171..d5c249c2 100644 --- a/js/nostrToolsBootstrap.js +++ b/js/nostrToolsBootstrap.js @@ -304,14 +304,14 @@ export function bootstrapNostrTools() { const remoteImports = [ withTimeout( - () => import("https://esm.sh/nostr-tools@1.8.3"), + () => import("https://esm.sh/nostr-tools@2.17.0"), REMOTE_IMPORT_TIMEOUT, "esm-main" ), withTimeout( () => import( - "https://esm.sh/nostr-tools@1.8.3?target=es2022&exports=nip04" + "https://esm.sh/nostr-tools@2.17.0?target=es2022&exports=nip04" ), REMOTE_IMPORT_TIMEOUT, "esm-nip04" @@ -319,7 +319,7 @@ export function bootstrapNostrTools() { withTimeout( () => import( - "https://esm.sh/nostr-tools@1.8.3?target=es2022&exports=nip44" + "https://esm.sh/nostr-tools@2.17.0/nip44?target=es2022" ), REMOTE_IMPORT_TIMEOUT, "esm-nip44" diff --git a/js/payments/lnurl.js b/js/payments/lnurl.js index 52d536b8..36cb8fb5 100644 --- a/js/payments/lnurl.js +++ b/js/payments/lnurl.js @@ -112,6 +112,36 @@ function convertWords(words, fromBits, toBits, { pad = true } = {}) { return result; } +function createChecksum(hrp, data) { + const values = [...hrpExpand(hrp), ...data, 0, 0, 0, 0, 0, 0]; + const mod = polymod(values) ^ 1; + const checksum = []; + for (let i = 0; i < 6; i += 1) { + checksum.push((mod >> ((5 - i) * 5)) & 31); + } + return checksum; +} + +function bech32Encode(hrp, data) { + const checksum = createChecksum(hrp, data); + const combined = [...data, ...checksum]; + const encodedData = combined.map((value) => { + if (value < 0 || value >= CHARSET.length) { + throw new Error("Invalid bech32 word value."); + } + return CHARSET[value]; + }); + return `${hrp}1${encodedData.join("")}`; +} + +export function encodeLnurlBech32(url) { + const sanitized = sanitizeUrl(url); + const encoder = new TextEncoder(); + const bytes = Array.from(encoder.encode(sanitized)); + const words = convertWords(bytes, 8, 5, { pad: true }); + return bech32Encode("lnurl", words).toLowerCase(); +} + function decodeLnurlBech32(encoded) { const { prefix, words } = bech32Decode(encoded); if (prefix !== "lnurl") { @@ -301,7 +331,7 @@ function truncateComment(comment, limit) { export async function requestInvoice( metadata, - { amountSats, amountMsats, comment, zapRequest, fetcher } = {} + { amountSats, amountMsats, comment, zapRequest, lnurl, fetcher } = {} ) { if (!metadata || typeof metadata !== "object") { throw new Error("LNURL metadata is required to request an invoice."); @@ -326,6 +356,11 @@ export async function requestInvoice( callbackUrl.searchParams.set("nostr", zapRequest); } + const originalLnurl = typeof lnurl === "string" ? lnurl.trim() : ""; + if (originalLnurl) { + callbackUrl.searchParams.set("lnurl", originalLnurl); + } + const response = await fetchFn(callbackUrl.toString(), { method: "GET", headers: { Accept: "application/json" }, @@ -366,7 +401,9 @@ export async function requestInvoice( } export const __TESTING__ = Object.freeze({ + bech32Encode, bech32Decode, decodeLnurlBech32, convertWords, + createChecksum, }); diff --git a/js/payments/nwcClient.js b/js/payments/nwcClient.js index 435c317c..752d8250 100644 --- a/js/payments/nwcClient.js +++ b/js/payments/nwcClient.js @@ -2,6 +2,7 @@ import { nostrToolsReady } from "../nostrToolsBootstrap.js"; import { userLogger } from "../utils/logger.js"; +import { isZapAllowanceExhaustedError } from "./zapSharedState.js"; const HEX64_REGEX = /^[0-9a-f]{64}$/i; const URI_SCHEMES = [ @@ -330,16 +331,24 @@ function parseNwcUri(uri) { const queryParams = {}; for (const [key, values] of additionalParams.entries()) { - if (!values || !values.length) { + if (!Array.isArray(values) || !values.length) { continue; } - if (values.length === 1) { - queryParams[key] = values[0]; + const sanitizedValues = values + .map((value) => sanitizeQueryValue(value)) + .filter(Boolean); + if (!sanitizedValues.length) { + continue; + } + if (sanitizedValues.length === 1) { + queryParams[key] = sanitizedValues[0]; } else { - queryParams[key] = values.slice(); + queryParams[key] = sanitizedValues.slice(); } } + const budgetMetadata = deriveBudgetMetadata(additionalParams); + return { normalizedUri: `nostr+walletconnect://${walletPubkey}?${normalizedParams.toString()}`, relays, @@ -347,6 +356,7 @@ function parseNwcUri(uri) { secretKey, clientPubkey, queryParams, + budget: budgetMetadata, }; } @@ -360,6 +370,238 @@ function normalizeSpaceSeparatedValues(value) { .filter(Boolean); } +function sanitizeQueryValue(value) { + if (typeof value === "string") { + const trimmed = value.trim(); + return trimmed ? trimmed : null; + } + if (typeof value === "number" && Number.isFinite(value)) { + return String(value); + } + if (typeof value === "bigint") { + return value >= 0n ? value.toString() : null; + } + return null; +} + +function coercePositiveBigInt(value) { + if (typeof value === "bigint") { + return value >= 0n ? value : null; + } + if (typeof value === "number") { + if (!Number.isFinite(value)) { + return null; + } + const rounded = Math.round(value); + return rounded >= 0 ? BigInt(rounded) : null; + } + if (typeof value === "string") { + const trimmed = value.trim(); + if (!trimmed) { + return null; + } + const normalized = trimmed.replace(/_/g, ""); + if (!/^-?\d+$/.test(normalized)) { + return null; + } + try { + const big = BigInt(normalized); + return big >= 0n ? big : null; + } catch (error) { + return null; + } + } + return null; +} + +function getFirstQueryValue(map, keys) { + if (!map || !keys || !keys.length) { + return null; + } + for (const key of keys) { + const values = map.get(key); + if (!Array.isArray(values) || !values.length) { + continue; + } + for (const candidate of values) { + const sanitized = sanitizeQueryValue(candidate); + if (sanitized) { + return sanitized; + } + } + } + return null; +} + +const BUDGET_RENEWAL_FIELD_ALIASES = { + "": "interval", + value: "interval", + interval: "interval", + period: "interval", + frequency: "frequency", + every: "every", + each: "every", + unit: "unit", + units: "unit", + ms: "milliseconds", + millis: "milliseconds", + milliseconds: "milliseconds", + second: "seconds", + seconds: "seconds", + sec: "seconds", + start: "startAt", + at: "startAt", + time: "startAt", + timestamp: "startAt", + date: "startAt", +}; + +function deriveBudgetRenewalMetadata(normalizedLookup) { + if (!normalizedLookup || !normalizedLookup.size) { + return null; + } + + const renewal = {}; + + for (const [rawKey, values] of normalizedLookup.entries()) { + if ( + !rawKey.startsWith("budget_renewal") && + !rawKey.startsWith("budgetrenewal") + ) { + continue; + } + if (!Array.isArray(values) || !values.length) { + continue; + } + const candidate = values.find((value) => sanitizeQueryValue(value)); + if (!candidate) { + continue; + } + + const normalizedKey = rawKey + .replace(/^budget_renewal_?/, "") + .replace(/^budgetrenewal_?/, ""); + const alias = BUDGET_RENEWAL_FIELD_ALIASES[normalizedKey]; + const field = alias || (normalizedKey || "interval"); + + if (!(field in renewal)) { + renewal[field] = sanitizeQueryValue(candidate); + } + } + + return Object.keys(renewal).length ? renewal : null; +} + +function deriveBudgetMetadata(additionalParams) { + if (!additionalParams || !(additionalParams instanceof Map)) { + return null; + } + + const normalizedLookup = new Map(); + + for (const [key, values] of additionalParams.entries()) { + if (!Array.isArray(values) || !values.length) { + continue; + } + const normalizedValues = values + .map((value) => sanitizeQueryValue(value)) + .filter(Boolean); + if (!normalizedValues.length) { + continue; + } + const lowerKey = typeof key === "string" ? key.toLowerCase() : ""; + if (!lowerKey) { + continue; + } + if (!normalizedLookup.has(lowerKey)) { + normalizedLookup.set(lowerKey, []); + } + normalizedLookup.get(lowerKey).push(...normalizedValues); + } + + const budgetValue = getFirstQueryValue(normalizedLookup, [ + "budget", + "budget_msat", + "budgetmsat", + "budget_msats", + "budgetmsats", + ]); + const totalMsats = coercePositiveBigInt(budgetValue); + const renewal = deriveBudgetRenewalMetadata(normalizedLookup); + + if (totalMsats !== null && totalMsats !== undefined) { + return { + totalMsats, + renewal, + raw: { budget: budgetValue }, + }; + } + + if (renewal) { + return { + totalMsats: null, + renewal, + raw: { budget: budgetValue }, + }; + } + + return null; +} + +function createBudgetTracker(budgetMetadata) { + if (!budgetMetadata || typeof budgetMetadata !== "object") { + return null; + } + + const total = coercePositiveBigInt(budgetMetadata.totalMsats); + if (total === null || total === undefined) { + return null; + } + + const tracker = { + totalMsats: total, + spentMsats: 0n, + renewal: budgetMetadata.renewal || null, + exhausted: false, + }; + + if (tracker.totalMsats === 0n) { + tracker.exhausted = true; + } + + return tracker; +} + +function getBudgetRemainingMsats(tracker) { + if (!tracker) { + return null; + } + const remaining = tracker.totalMsats - tracker.spentMsats; + return remaining > 0n ? remaining : 0n; +} + +function incrementBudgetSpend(tracker, amountMsats) { + if (!tracker || typeof amountMsats !== "bigint") { + return; + } + const next = tracker.spentMsats + (amountMsats >= 0n ? amountMsats : 0n); + tracker.spentMsats = next; + if (tracker.spentMsats >= tracker.totalMsats) { + tracker.spentMsats = tracker.totalMsats; + tracker.exhausted = true; + } +} + +function markBudgetTrackerExhausted(tracker) { + if (!tracker) { + return; + } + tracker.exhausted = true; + if (tracker.spentMsats > tracker.totalMsats) { + tracker.spentMsats = tracker.totalMsats; + } +} + function hexToBytesCompat(hex) { const tools = getNostrTools(); const candidate = tools?.utils?.hexToBytes; @@ -627,7 +869,8 @@ async function ensureEncryption(context) { } } - const { schemes: walletSchemes } = getWalletSupportedEncryption(infoEvent); + const { schemes: walletSchemes, explicit: walletSchemesExplicit } = + getWalletSupportedEncryption(infoEvent); const candidates = getEncryptionCandidates(context).filter((candidate) => { return !state.unsupported.has(candidate.scheme); }); @@ -636,6 +879,19 @@ async function ensureEncryption(context) { ? candidates.filter((candidate) => walletSchemes.includes(candidate.scheme)) : candidates; + if ( + compatibleCandidates.length > 1 && + (!walletSchemesExplicit || !walletSchemes.includes("nip44_v2")) + ) { + const nip04Index = compatibleCandidates.findIndex( + (candidate) => candidate.scheme === "nip04" + ); + if (nip04Index > 0) { + const [nip04Candidate] = compatibleCandidates.splice(nip04Index, 1); + compatibleCandidates.unshift(nip04Candidate); + } + } + if (compatibleCandidates.length) { const selected = compatibleCandidates[0]; context.encryption = selected; @@ -659,6 +915,45 @@ async function ensureEncryption(context) { throw new Error("No compatible wallet encryption scheme available."); } +function shouldRetryWithFallback(context, error, encryption, { hasRetried }) { + if (!context || !encryption || hasRetried) { + return false; + } + + const code = typeof error?.code === "string" ? error.code : ""; + const message = typeof error?.message === "string" ? error.message : ""; + + if (code === "UNSUPPORTED_ENCRYPTION" || code === "unsupported_encryption") { + return true; + } + + const isTimeout = + message === "Wallet request timed out." || + code === "timeout" || + code === "TIMEOUT"; + + if (!isTimeout || encryption.scheme !== "nip44_v2") { + return false; + } + + const state = ensureEncryptionState(context); + if (state.unsupported.has("nip04")) { + return false; + } + + const { schemes, explicit } = getWalletSupportedEncryption(context.infoEvent); + if (explicit && schemes.includes("nip44_v2") && !schemes.includes("nip04")) { + return false; + } + + return getEncryptionCandidates(context).some((candidate) => { + if (candidate.scheme !== "nip04") { + return false; + } + return !state.unsupported.has(candidate.scheme); + }); +} + function finalizePendingRequest(entry) { if (!entry || typeof entry !== "object") { return; @@ -939,6 +1234,13 @@ function ensureActiveState(settings) { activeState.context.relayUrls = parsed.relays.slice(); activeState.context.relays = parsed.relays.slice(); activeState.context.queryParams = parsed.queryParams; + activeState.context.budget = parsed.budget || null; + if (!activeState.context.budgetTracker && parsed.budget) { + activeState.context.budgetTracker = createBudgetTracker(parsed.budget); + } else if (activeState.context.budgetTracker) { + activeState.context.budgetTracker.renewal = + parsed.budget?.renewal || null; + } } return activeState.context; } @@ -957,6 +1259,8 @@ function ensureActiveState(settings) { clientPubkey: parsed.clientPubkey, uri: parsed.normalizedUri, queryParams: parsed.queryParams, + budget: parsed.budget || null, + budgetTracker: createBudgetTracker(parsed.budget), infoEvent: null, encryption: null, encryptionState: { unsupported: new Set() }, @@ -1053,11 +1357,9 @@ async function sendWalletRequest(context, payload, { timeoutMs, __internalRetry } catch (error) { const encryption = context?.encryption || null; if ( - !__internalRetry && - encryption && - error && - typeof error === "object" && - (error.code === "UNSUPPORTED_ENCRYPTION" || error.code === "unsupported_encryption") + shouldRetryWithFallback(context, error, encryption, { + hasRetried: __internalRetry === true, + }) ) { rememberUnsupportedEncryption(context, encryption.scheme); context.encryption = null; @@ -1083,7 +1385,174 @@ function sanitizeAmount(amount) { return Math.max(0, rounded); } -function buildPayInvoiceParams({ invoice, amountSats, zapRequest }) { +const WALLET_BUDGET_ERROR_CODES = new Set([ + "allowance_exceeded", + "allowance_exhausted", + "budget_exceeded", + "budget_exhausted", + "budget_limit_reached", + "budget_spent", + "quota_exceeded", + "spending_allowance_exceeded", + "spending_limit_reached", + "nwc_budget_exhausted", +]); + +const BOLT11_PICO_MULTIPLIERS = { + "": 12n, + m: 9n, + u: 6n, + n: 3n, + p: 0n, +}; + +function normalizeErrorCode(code) { + if (typeof code !== "string") { + return ""; + } + return code + .trim() + .toLowerCase() + .replace(/[^a-z0-9]+/g, "_"); +} + +function toMsatsFromSats(amount) { + if (!Number.isFinite(amount)) { + return null; + } + const rounded = Math.round(amount); + const clamped = Math.max(0, rounded); + return BigInt(clamped) * 1000n; +} + +function toMsatsFromValue(amount) { + if (typeof amount === "bigint") { + return amount >= 0n ? amount : 0n; + } + if (typeof amount === "number") { + if (!Number.isFinite(amount)) { + return null; + } + const rounded = Math.round(amount); + const clamped = Math.max(0, rounded); + return BigInt(clamped); + } + if (typeof amount === "string") { + const big = coercePositiveBigInt(amount); + if (big === null) { + return null; + } + return big; + } + return null; +} + +function decodeBolt11AmountMsats(invoice) { + if (typeof invoice !== "string") { + return null; + } + const trimmed = invoice.trim(); + if (!trimmed) { + return null; + } + const lower = trimmed.toLowerCase(); + if (!lower.startsWith("ln")) { + return null; + } + + let index = 2; + while (index < lower.length && /[a-z]/.test(lower[index])) { + index += 1; + } + + const digitsStart = index; + while (index < lower.length && /[0-9]/.test(lower[index])) { + index += 1; + } + + const digits = lower.slice(digitsStart, index); + if (!digits) { + return null; + } + + const unitChar = index < lower.length && /[munp]/.test(lower[index]) ? lower[index] : ""; + if (unitChar) { + index += 1; + } + + try { + const base = BigInt(digits); + const exponent = BOLT11_PICO_MULTIPLIERS[unitChar]; + if (typeof exponent === "undefined") { + return null; + } + const pico = base * 10n ** exponent; + if (pico % 10n !== 0n) { + return null; + } + return pico / 10n; + } catch (error) { + return null; + } +} + +function resolvePaymentAmountMsats({ invoice, params, amountSats }) { + const fromSats = Number.isFinite(amountSats) ? toMsatsFromSats(amountSats) : null; + if (fromSats !== null) { + return { msats: fromSats, source: "amountSats" }; + } + + const paramAmount = params && typeof params === "object" ? params.amount : null; + const fromParams = toMsatsFromValue(paramAmount); + if (fromParams !== null) { + return { msats: fromParams, source: "params.amount" }; + } + + const decoded = decodeBolt11AmountMsats(invoice); + if (decoded !== null) { + return { msats: decoded, source: "invoice" }; + } + + return { msats: null, source: null }; +} + +function isBudgetOrAllowanceError(error) { + const normalizedCode = normalizeErrorCode(error?.code); + if (normalizedCode && WALLET_BUDGET_ERROR_CODES.has(normalizedCode)) { + return true; + } + return isZapAllowanceExhaustedError(error); +} + +function createBudgetExceededError(tracker, chargeMsats, { remainingMsats }) { + const message = + "Budget exceeded. Increase your wallet zap limit or reduce the platform fee, then try again."; + const error = new Error(message); + error.code = "NWC_BUDGET_EXHAUSTED"; + + if (typeof chargeMsats === "bigint") { + error.requestedMsats = chargeMsats; + } + + if (tracker) { + error.budgetMsats = tracker.totalMsats; + if (typeof remainingMsats === "bigint") { + error.remainingMsats = remainingMsats >= 0n ? remainingMsats : 0n; + } else { + const remaining = getBudgetRemainingMsats(tracker); + if (typeof remaining === "bigint") { + error.remainingMsats = remaining; + } + } + if (tracker.renewal) { + error.budgetRenewal = tracker.renewal; + } + } + + return error; +} + +function buildPayInvoiceParams({ invoice, amountSats, zapRequest, lnurl }) { const params = { invoice }; const amount = sanitizeAmount(amountSats); @@ -1095,21 +1564,68 @@ function buildPayInvoiceParams({ invoice, amountSats, zapRequest }) { params.zap_request = zapRequest; } + if (typeof lnurl === "string") { + const trimmed = lnurl.trim(); + if (trimmed) { + params.lnurl = trimmed; + } + } + return params; } -export async function sendPayment(bolt11, { settings, amountSats, zapRequest, timeoutMs } = {}) { +export async function sendPayment( + bolt11, + { settings, amountSats, zapRequest, lnurl, timeoutMs } = {} +) { const context = await ensureWallet({ settings }); const invoice = sanitizeInvoice(bolt11); - const params = buildPayInvoiceParams({ invoice, amountSats, zapRequest }); + const params = buildPayInvoiceParams({ invoice, amountSats, zapRequest, lnurl }); + const amountInfo = resolvePaymentAmountMsats({ + invoice, + params, + amountSats, + }); + const chargeMsats = amountInfo.msats; + const tracker = context?.budgetTracker || null; + + if (tracker) { + const remaining = getBudgetRemainingMsats(tracker); + const exhausted = tracker.exhausted || (typeof remaining === "bigint" && remaining === 0n); + const exceedsBudget = + typeof chargeMsats === "bigint" && typeof remaining === "bigint" + ? chargeMsats > remaining + : false; + + if (exhausted || exceedsBudget) { + const error = createBudgetExceededError(tracker, chargeMsats, { + remainingMsats: typeof remaining === "bigint" ? remaining : null, + }); + if (exhausted || (typeof remaining === "bigint" && remaining === 0n)) { + markBudgetTrackerExhausted(tracker); + } + throw error; + } + } + const payload = { id: `req-${Date.now()}-${++requestCounter}`, method: "pay_invoice", params, }; - const response = await sendWalletRequest(context, payload, { timeoutMs }); - return response; + try { + const response = await sendWalletRequest(context, payload, { timeoutMs }); + if (tracker && typeof chargeMsats === "bigint" && chargeMsats > 0n) { + incrementBudgetSpend(tracker, chargeMsats); + } + return response; + } catch (error) { + if (tracker && isBudgetOrAllowanceError(error)) { + markBudgetTrackerExhausted(tracker); + } + throw error; + } } export function getActiveWalletContext() { diff --git a/js/payments/zapReceiptValidator.js b/js/payments/zapReceiptValidator.js new file mode 100644 index 00000000..675f0b89 --- /dev/null +++ b/js/payments/zapReceiptValidator.js @@ -0,0 +1,445 @@ +// js/payments/zapReceiptValidator.js + +import { nostrToolsReady } from "../nostrToolsBootstrap.js"; +import { normalizeToolkitCandidate, readToolkitFromScope } from "../nostr/toolkit.js"; +import { userLogger } from "../utils/logger.js"; +import { bech32, bytesToHex, sha256 } from "../../vendor/crypto-helpers.bundle.min.js"; + +const ZAP_RECEIPT_KIND = 9735; +const BOLT11_CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l"; +const textEncoder = new TextEncoder(); + +const globalScope = + typeof window !== "undefined" + ? window + : typeof globalThis !== "undefined" + ? globalThis + : null; + +const nostrToolsReadySource = + globalScope && + globalScope.nostrToolsReady && + typeof globalScope.nostrToolsReady.then === "function" + ? globalScope.nostrToolsReady + : nostrToolsReady; + +let cachedTools = null; + +function rememberTools(candidate) { + const normalized = normalizeToolkitCandidate(candidate); + if (normalized) { + cachedTools = normalized; + } +} + +async function ensureNostrTools() { + if (cachedTools) { + return cachedTools; + } + try { + const result = await nostrToolsReadySource; + rememberTools(result); + } catch (error) { + userLogger.warn("[zapReceiptValidator] Failed to await nostr tools bootstrap.", error); + } + if (!cachedTools) { + rememberTools(readToolkitFromScope(globalScope)); + } + return cachedTools; +} + +function computeZapRequestHash(zapRequest) { + const payload = typeof zapRequest === "string" ? zapRequest : ""; + const data = textEncoder.encode(payload); + return bytesToHex(sha256(data)); +} + +function normalizeRelayList(relays) { + if (!Array.isArray(relays)) { + return []; + } + const seen = new Set(); + const normalized = []; + for (const relay of relays) { + if (typeof relay !== "string") { + continue; + } + const trimmed = relay.trim(); + if (!trimmed || seen.has(trimmed)) { + continue; + } + seen.add(trimmed); + normalized.push(trimmed); + } + return normalized; +} + +function parseZapRequest(zapRequest) { + if (typeof zapRequest !== "string" || !zapRequest.trim()) { + return null; + } + try { + return JSON.parse(zapRequest); + } catch (error) { + return null; + } +} + +function resolveRelayUrls(zapEvent) { + if (!zapEvent || typeof zapEvent !== "object" || !Array.isArray(zapEvent.tags)) { + return []; + } + const relaysTag = zapEvent.tags.find((tag) => Array.isArray(tag) && tag[0] === "relays"); + if (!relaysTag) { + return []; + } + return normalizeRelayList(relaysTag.slice(1)); +} + +function normalizeInvoiceValue(invoice) { + if (typeof invoice !== "string") { + return ""; + } + const trimmed = invoice.trim(); + return trimmed ? trimmed : ""; +} + +function normalizePubkey(pubkey) { + if (typeof pubkey !== "string") { + return ""; + } + const trimmed = pubkey.trim(); + return trimmed ? trimmed.toLowerCase() : ""; +} + +function extractDescriptionHashFromBolt11(bolt11) { + const normalized = normalizeInvoiceValue(bolt11).toLowerCase(); + if (!normalized) { + return null; + } + + let decoded; + try { + decoded = bech32.decode(normalized, 2000); + } catch (error) { + return null; + } + + const words = Array.isArray(decoded?.words) ? decoded.words.slice() : []; + if (!words.length) { + return null; + } + + if (words.length <= 104) { + return null; + } + + const dataWords = words.slice(0, -104); + if (dataWords.length <= 7) { + return null; + } + + let index = 7; // skip timestamp words + while (index < dataWords.length) { + const tagCode = dataWords[index]; + index += 1; + if (typeof tagCode !== "number" || tagCode < 0 || tagCode >= BOLT11_CHARSET.length) { + return null; + } + if (index + 1 >= dataWords.length) { + return null; + } + const length = (dataWords[index] << 5) + dataWords[index + 1]; + index += 2; + if (length < 0 || index + length > dataWords.length) { + return null; + } + const dataSlice = dataWords.slice(index, index + length); + index += length; + const tag = BOLT11_CHARSET[tagCode]; + if (tag === "h") { + try { + const bytes = bech32.fromWords(dataSlice); + return bytesToHex(Uint8Array.from(bytes)); + } catch (error) { + return null; + } + } + } + + return null; +} + +function getInvoiceAmountSats(bolt11, tools, override) { + if (typeof override === "function") { + try { + const overrideResult = override(bolt11); + const normalized = Number(overrideResult); + if (Number.isFinite(normalized)) { + return Math.max(0, Math.round(normalized)); + } + } catch (error) { + userLogger.warn("[zapReceiptValidator] Custom bolt11 amount parser failed.", error); + } + } + const fn = tools?.nip57?.getSatoshisAmountFromBolt11; + if (typeof fn !== "function") { + return null; + } + try { + const result = Number(fn(bolt11)); + if (!Number.isFinite(result)) { + return null; + } + return Math.max(0, Math.round(result)); + } catch (error) { + userLogger.warn("[zapReceiptValidator] Failed to parse bolt11 amount via nostr-tools.", error); + return null; + } +} + +function buildValidationResult({ + status = "skipped", + reason = null, + event = null, + relays = [], +} = {}) { + return { + status, + reason, + event, + checkedRelays: Array.isArray(relays) ? relays.slice() : [], + }; +} + +export async function validateZapReceipt(context = {}, overrides = {}) { + const { + zapRequest, + amountSats, + metadata, + invoice, + payment, + } = context || {}; + + const zapRequestString = typeof zapRequest === "string" ? zapRequest : ""; + if (!zapRequestString) { + return buildValidationResult({ + status: "skipped", + reason: "Zap request was not provided.", + }); + } + + const parsedZapRequest = parseZapRequest(zapRequestString); + if (!parsedZapRequest) { + return buildValidationResult({ + status: "failed", + reason: "Zap request JSON could not be parsed.", + }); + } + + const relayUrls = resolveRelayUrls(parsedZapRequest); + if (!relayUrls.length) { + return buildValidationResult({ + status: "failed", + reason: "Zap request did not specify any relays.", + }); + } + + const invoiceCandidate = + normalizeInvoiceValue(invoice?.invoice ?? invoice) || + normalizeInvoiceValue(payment?.invoice ?? payment?.bolt11 ?? ""); + if (!invoiceCandidate) { + return buildValidationResult({ + status: "failed", + reason: "Zap invoice was not available for validation.", + relays: relayUrls, + }); + } + + const expectedHash = computeZapRequestHash(zapRequestString); + const decodeHash = overrides.decodeDescriptionHash || extractDescriptionHashFromBolt11; + let invoiceHash = null; + try { + invoiceHash = decodeHash(invoiceCandidate); + } catch (error) { + userLogger.warn( + "[zapReceiptValidator] Custom description hash decoder threw an error.", + error + ); + invoiceHash = null; + } + + if (!invoiceHash) { + return buildValidationResult({ + status: "failed", + reason: "Zap invoice did not include a description hash.", + relays: relayUrls, + }); + } + + if (invoiceHash !== expectedHash) { + return buildValidationResult({ + status: "failed", + reason: "Zap invoice description hash did not match the zap request.", + relays: relayUrls, + }); + } + + const tools = overrides.nostrTools || (await ensureNostrTools()); + if (!tools || typeof tools !== "object") { + return buildValidationResult({ + status: "failed", + reason: "nostr-tools helpers are unavailable.", + relays: relayUrls, + }); + } + + if (typeof tools.validateEvent !== "function" || typeof tools.verifyEvent !== "function") { + return buildValidationResult({ + status: "failed", + reason: "nostr-tools validation helpers are missing.", + relays: relayUrls, + }); + } + + const expectedAmount = Math.max(0, Math.round(Number(amountSats || 0))); + if (expectedAmount > 0) { + const amount = getInvoiceAmountSats(invoiceCandidate, tools, overrides.getAmountFromBolt11); + if (!Number.isFinite(amount) || amount <= 0) { + return buildValidationResult({ + status: "failed", + reason: "Zap invoice amount could not be determined.", + relays: relayUrls, + }); + } + if (amount !== expectedAmount) { + return buildValidationResult({ + status: "failed", + reason: "Zap invoice amount did not match the expected share.", + relays: relayUrls, + }); + } + } + + const expectedPubkey = normalizePubkey(metadata?.nostrPubkey); + if (!expectedPubkey) { + return buildValidationResult({ + status: "failed", + reason: "LNURL metadata is missing a nostrPubkey for receipt validation.", + relays: relayUrls, + }); + } + + let pool; + try { + if (typeof overrides.createPool === "function") { + pool = overrides.createPool(tools); + } else if (typeof tools.SimplePool === "function") { + pool = new tools.SimplePool(); + } + } catch (error) { + userLogger.warn("[zapReceiptValidator] Failed to create SimplePool instance.", error); + pool = null; + } + + if (!pool || typeof pool.list !== "function") { + return buildValidationResult({ + status: "failed", + reason: "Unable to initialize a relay pool for receipt validation.", + relays: relayUrls, + }); + } + + const filters = [ + { + kinds: [ZAP_RECEIPT_KIND], + "#bolt11": [invoiceCandidate.toLowerCase()], + limit: 10, + }, + ]; + + let events = []; + try { + if (typeof overrides.listEvents === "function") { + events = await overrides.listEvents(pool, relayUrls, filters); + } else { + events = await pool.list(relayUrls, filters); + } + } catch (error) { + userLogger.warn("[zapReceiptValidator] Failed to fetch zap receipts from relays.", error); + events = []; + } finally { + try { + if (typeof pool.close === "function") { + pool.close(relayUrls); + } + } catch (error) { + // Ignore close errors. + } + } + + if (!Array.isArray(events) || !events.length) { + return buildValidationResult({ + status: "failed", + reason: "No zap receipt was published on the advertised relays.", + relays: relayUrls, + }); + } + + const normalizedBolt = invoiceCandidate.toLowerCase(); + const successfulEvent = events.find((event) => { + if (!event || typeof event !== "object") { + return false; + } + if (event.kind !== ZAP_RECEIPT_KIND) { + return false; + } + if (!tools.validateEvent(event) || !tools.verifyEvent(event)) { + return false; + } + const pubkey = normalizePubkey(event.pubkey); + if (!pubkey || pubkey !== expectedPubkey) { + return false; + } + if (!Array.isArray(event.tags)) { + return false; + } + const boltTag = event.tags.find( + (tag) => + Array.isArray(tag) && + tag[0] === "bolt11" && + typeof tag[1] === "string" && + tag[1].trim().toLowerCase() === normalizedBolt + ); + if (!boltTag) { + return false; + } + const descriptionTag = event.tags.find( + (tag) => Array.isArray(tag) && tag[0] === "description" && typeof tag[1] === "string" + ); + if (!descriptionTag) { + return false; + } + const descriptionValue = descriptionTag[1]; + return descriptionValue === zapRequestString; + }); + + if (!successfulEvent) { + return buildValidationResult({ + status: "failed", + reason: "No compliant zap receipt matched the zap request.", + relays: relayUrls, + }); + } + + return buildValidationResult({ + status: "passed", + event: successfulEvent, + relays: relayUrls, + }); +} + +export const __TESTING__ = Object.freeze({ + computeZapRequestHash, + extractDescriptionHashFromBolt11, +}); diff --git a/js/payments/zapSharedState.js b/js/payments/zapSharedState.js index 21cc7746..9ac0fef4 100644 --- a/js/payments/zapSharedState.js +++ b/js/payments/zapSharedState.js @@ -162,3 +162,118 @@ export function clearZapCaches() { } export { validateInvoiceAmount }; + +function extractErrorMessage(error) { + if (!error) { + return ""; + } + if (typeof error === "string") { + return error; + } + if (typeof error?.message === "string") { + return error.message; + } + if (typeof error?.reason === "string") { + return error.reason; + } + if (typeof error?.error?.message === "string") { + return error.error.message; + } + if (typeof error?.data?.error === "string") { + return error.data.error; + } + if (typeof error?.data?.error?.message === "string") { + return error.data.error.message; + } + return ""; +} + +const ALLOWANCE_ERROR_CODES = new Set([ + "allowance_exceeded", + "allowance_exhausted", + "budget_exceeded", + "budget_exhausted", + "budget_limit_reached", + "budget_spent", + "quota_exceeded", + "spending_allowance_exceeded", + "spending_limit_reached", + "nwc_budget_exhausted", +]); + +const ALLOWANCE_ERROR_PATTERNS = [ + "budget exceeded", + "allowance exceeded", + "allowance exhausted", + "allowance spent", + "allowance depleted", + "allowance limit reached", + "spending allowance exceeded", + "spending allowance reached", + "spending limit reached", + "quota exceeded", +]; + +export function isZapAllowanceExhaustedError(error) { + const code = + typeof error?.code === "string" + ? error.code.trim().toLowerCase().replace(/[^a-z0-9]+/g, "_") + : ""; + if (code && ALLOWANCE_ERROR_CODES.has(code)) { + return true; + } + + const message = extractErrorMessage(error); + if (!message) { + return false; + } + const normalized = message.toLowerCase(); + if (ALLOWANCE_ERROR_PATTERNS.some((pattern) => normalized.includes(pattern))) { + return true; + } + if (normalized.includes("allowance") && normalized.includes("zap")) { + if ( + normalized.includes("exceed") || + normalized.includes("exhaust") || + normalized.includes("spent") || + normalized.includes("deplet") + ) { + return true; + } + } + if (normalized.includes("budget") && normalized.includes("zap")) { + if ( + normalized.includes("exceed") || + normalized.includes("spent") || + normalized.includes("deplet") + ) { + return true; + } + } + return false; +} + +const ALLOWANCE_GUIDANCE_SUFFIX = + "Increase your wallet zap limit or reduce the platform split to continue."; +const DEFAULT_ALLOWANCE_MESSAGE = + "Your wallet's zap allowance has been exhausted. " + ALLOWANCE_GUIDANCE_SUFFIX; + +export function buildZapAllowanceExhaustedMessage(error) { + const baseMessage = extractErrorMessage(error).trim(); + if (!baseMessage) { + return DEFAULT_ALLOWANCE_MESSAGE; + } + const normalized = baseMessage.toLowerCase(); + const punctuation = /[.!?]$/.test(baseMessage) ? "" : "."; + if ( + normalized.includes("zap allowance") && + normalized.includes("increase") && + normalized.includes("platform split") + ) { + return baseMessage; + } + if (normalized.includes("zap") && normalized.includes("allowance")) { + return `${baseMessage}${punctuation} ${ALLOWANCE_GUIDANCE_SUFFIX}`; + } + return `${baseMessage}${punctuation} ${DEFAULT_ALLOWANCE_MESSAGE}`; +} diff --git a/js/payments/zapSplit.js b/js/payments/zapSplit.js index 21e7bddb..d9109855 100644 --- a/js/payments/zapSplit.js +++ b/js/payments/zapSplit.js @@ -7,10 +7,13 @@ import { fetchPayServiceData, validateInvoiceAmount, requestInvoice, + encodeLnurlBech32, } from "./lnurl.js"; import { ensureWallet, sendPayment } from "./nwcClient.js"; import { getPlatformLightningAddress } from "./platformAddress.js"; +import { RELAY_URLS } from "../nostr/toolkit.js"; import { userLogger } from "../utils/logger.js"; +import { validateZapReceipt } from "./zapReceiptValidator.js"; import { clampPercent, parsePercentValue, @@ -25,9 +28,11 @@ const DEFAULT_DEPS = Object.freeze({ fetchPayServiceData, validateInvoiceAmount, requestInvoice, + encodeLnurlBech32, }), wallet: Object.freeze({ ensureWallet, sendPayment }), platformAddress: Object.freeze({ getPlatformLightningAddress }), + validator: Object.freeze({ validateZapReceipt }), }); const globalScope = @@ -206,7 +211,17 @@ function mergeDependencies(overrides = {}) { ...(overrides.platformAddress || {}), }; - return { lnurl: lnurlDeps, wallet: walletDeps, platformAddress: platformDeps }; + const validatorDeps = { + ...DEFAULT_DEPS.validator, + ...(overrides.validator || {}), + }; + + return { + lnurl: lnurlDeps, + wallet: walletDeps, + platformAddress: platformDeps, + validator: validatorDeps, + }; } function getNostrTools() { @@ -271,6 +286,58 @@ function derivePointerTag(videoEvent) { return ["a", value]; } +function resolveRelayUrls(wallet) { + const normalized = []; + const seen = new Set(); + + const addCandidate = (candidate) => { + if (!candidate) { + return; + } + if (Array.isArray(candidate)) { + candidate.forEach(addCandidate); + return; + } + if (typeof candidate === "string") { + const trimmed = candidate.trim(); + if (trimmed && !seen.has(trimmed)) { + seen.add(trimmed); + normalized.push(trimmed); + } + } + }; + + if (wallet && typeof wallet === "object") { + addCandidate(wallet.relayUrls); + addCandidate(wallet.relays); + addCandidate(wallet.relayUrl); + } + + if (!normalized.length) { + addCandidate(Array.isArray(RELAY_URLS) ? RELAY_URLS : []); + } + + return normalized; +} + +function resolveBech32Lnurl(resolved, encodeFn) { + const candidate = typeof resolved?.address === "string" ? resolved.address.trim() : ""; + if (candidate && candidate.toLowerCase().startsWith("lnurl")) { + return candidate.toLowerCase(); + } + + const callbackUrl = typeof resolved?.url === "string" ? resolved.url.trim() : ""; + if (!callbackUrl) { + return ""; + } + + if (typeof encodeFn !== "function") { + throw new Error("LNURL encoder is unavailable."); + } + + return encodeFn(callbackUrl); +} + function buildZapRequest({ wallet, recipientPubkey, @@ -295,13 +362,21 @@ function buildZapRequest({ if (pointerTag) { tags.push(pointerTag); } - if (lnurl) { - tags.push(["lnurl", lnurl]); + if (typeof lnurl === "string") { + const normalizedLnurl = lnurl.trim(); + if (normalizedLnurl) { + tags.push(["lnurl", normalizedLnurl]); + } } if (Number.isFinite(amountSats)) { tags.push(["amount", String(Math.max(0, Math.round(amountSats)) * 1000)]); } + const relayUrls = resolveRelayUrls(wallet); + if (relayUrls.length) { + tags.push(["relays", ...relayUrls]); + } + const event = { kind: ZAP_KIND, content: comment || "", @@ -342,6 +417,11 @@ async function processShare({ const metadata = await deps.lnurl.fetchPayServiceData(resolved.url); const { amountMsats } = deps.lnurl.validateInvoiceAmount(metadata, amountSats); + const lnurlTag = resolveBech32Lnurl(resolved, deps.lnurl.encodeLnurlBech32); + if (!lnurlTag) { + throw new Error("Unable to resolve LNURL for zap request."); + } + let zapRequest = null; if (metadata.allowsNostr === true || metadata.nostrPubkey) { const recipientPubkey = determineRecipientPubkey({ @@ -356,7 +436,7 @@ async function processShare({ videoEvent, amountSats, comment, - lnurl: resolved.url, + lnurl: lnurlTag, }); } } @@ -365,23 +445,84 @@ async function processShare({ amountMsats, comment, zapRequest, + lnurl: lnurlTag, }); - const payment = await deps.wallet.sendPayment(invoice.invoice, { - amountSats, - zapRequest, - }); + try { + const payment = await deps.wallet.sendPayment(invoice.invoice, { + amountSats, + zapRequest, + lnurl: lnurlTag, + }); - return { - recipientType, - address, - amount: amountSats, - lnurl: resolved, - metadata, - invoice, - payment, - zapRequest, - }; + let validation = null; + if (typeof deps.validator.validateZapReceipt === "function") { + try { + validation = await deps.validator.validateZapReceipt( + { + zapRequest, + amountSats, + metadata, + invoice, + payment, + lnurl: resolved, + recipientType, + address, + } + ); + } catch (validationError) { + userLogger.warn( + `[zapSplit] Zap receipt validation threw for ${recipientType} share.`, + validationError + ); + validation = { + status: "failed", + reason: "Zap receipt validation encountered an unexpected error.", + event: null, + }; + } + } + + const receipt = { + recipientType, + address, + amount: amountSats, + lnurl: resolved, + metadata, + invoice, + payment, + zapRequest, + status: "success", + }; + + if (validation && typeof validation === "object") { + receipt.validation = validation; + if (validation.status === "passed" && validation.event) { + receipt.validatedEvent = validation.event; + } else if (validation.status === "failed") { + receipt.validationFailed = true; + } + } + + return receipt; + } catch (error) { + userLogger.warn( + `[zapSplit] Failed to send ${recipientType} zap share.`, + error + ); + return { + recipientType, + address, + amount: amountSats, + lnurl: resolved, + metadata, + invoice, + payment: null, + zapRequest, + status: "error", + error, + }; + } } export async function splitAndZap( diff --git a/js/services/commentThreadService.js b/js/services/commentThreadService.js index 8d0a0feb..e02f62bf 100644 --- a/js/services/commentThreadService.js +++ b/js/services/commentThreadService.js @@ -2,10 +2,15 @@ import { devLogger } from "../utils/logger.js"; import { buildVideoAddressPointer } from "../utils/videoPointer.js"; +import { COMMENT_EVENT_KIND } from "../nostr/commentEvents.js"; +import { FEATURE_IMPROVED_COMMENT_FETCHING } from "../constants.js"; const ROOT_PARENT_KEY = "__root__"; const DEFAULT_INITIAL_LIMIT = 40; const DEFAULT_HYDRATION_DEBOUNCE_MS = 25; +const COMMENT_CACHE_PREFIX = "bitvid:comments:"; +const COMMENT_CACHE_TTL_MS = 5 * 60 * 1000; +const COMMENT_CACHE_VERSION = 2; function toPositiveInteger(value, fallback) { const numeric = Number(value); @@ -24,6 +29,16 @@ function normalizePubkey(pubkey) { return normalized ? normalized.toLowerCase() : ""; } +function normalizeKind(value) { + if (Number.isFinite(value)) { + return String(Math.floor(value)); + } + if (typeof value === "string" && value.trim()) { + return value.trim(); + } + return ""; +} + function toParentKey(parentId) { return parentId ? parentId : ROOT_PARENT_KEY; } @@ -56,21 +71,23 @@ export default class CommentThreadService { logger = devLogger, } = {}) { this.nostrClient = nostrClient; - this.app = app; - this.fetchVideoComments = - typeof fetchVideoComments === "function" - ? fetchVideoComments - : this.nostrClient && - typeof this.nostrClient.fetchVideoComments === "function" - ? (...args) => this.nostrClient.fetchVideoComments(...args) - : null; - this.subscribeVideoComments = - typeof subscribeVideoComments === "function" - ? subscribeVideoComments - : this.nostrClient && - typeof this.nostrClient.subscribeVideoComments === "function" - ? (...args) => this.nostrClient.subscribeVideoComments(...args) - : null; + this.fetchVideoComments = fetchVideoComments; + this.subscribeVideoComments = subscribeVideoComments; + + if (!this.fetchVideoComments && this.nostrClient) { + const clientFetcher = this.nostrClient.fetchVideoComments; + if (typeof clientFetcher === "function") { + this.fetchVideoComments = (...args) => clientFetcher.apply(this.nostrClient, args); + } + } + + if (!this.subscribeVideoComments && this.nostrClient) { + const clientSubscriber = this.nostrClient.subscribeVideoComments; + if (typeof clientSubscriber === "function") { + this.subscribeVideoComments = (...args) => clientSubscriber.apply(this.nostrClient, args); + } + } + this.getProfileCacheEntry = typeof getProfileCacheEntry === "function" ? getProfileCacheEntry @@ -112,7 +129,12 @@ export default class CommentThreadService { this.subscriptionCleanup = null; this.videoEventId = ""; this.videoAddressPointer = ""; + this.videoKind = ""; + this.videoAuthorPubkeyRaw = ""; + this.videoAuthorPubkey = ""; this.parentCommentId = ""; + this.parentCommentKind = ""; + this.parentCommentPubkey = ""; this.activeRelays = null; } @@ -136,12 +158,36 @@ export default class CommentThreadService { } = {}) { this.teardown(); + // Always ensure the pool is ready before proceeding + if (typeof this.nostrClient?.ensurePool === "function") { + try { + await this.nostrClient.ensurePool(); + } catch (error) { + this.emitError( + new Error("Unable to initialize Nostr pool before loading comments."), + ); + return { success: false, error }; + } + } else { + this.emitError( + new Error("Nostr client missing ensurePool implementation."), + ); + return { success: false }; + } + + const rawVideoAuthorPubkey = normalizeString(video?.pubkey); + this.videoEventId = normalizeString(video?.id); this.videoAddressPointer = buildVideoAddressPointer(video); + this.videoKind = normalizeKind(video?.kind); + this.videoAuthorPubkeyRaw = rawVideoAuthorPubkey; + this.videoAuthorPubkey = normalizePubkey(rawVideoAuthorPubkey); this.parentCommentId = normalizeString(parentCommentId); + this.parentCommentKind = this.parentCommentId ? String(COMMENT_EVENT_KIND) : ""; + this.parentCommentPubkey = ""; this.activeRelays = Array.isArray(relays) ? [...relays] : null; - if (!this.videoEventId || !this.videoAddressPointer) { + if (!this.videoEventId) { this.emitError( new Error("Unable to resolve video pointer for comment thread."), ); @@ -158,13 +204,31 @@ export default class CommentThreadService { const fetchLimit = toPositiveInteger(limit, this.defaultLimit); const target = { videoEventId: this.videoEventId, - videoDefinitionAddress: this.videoAddressPointer, parentCommentId: this.parentCommentId, }; + if (this.videoAddressPointer) { + target.videoDefinitionAddress = this.videoAddressPointer; + } + if (this.videoKind) { + target.videoKind = this.videoKind; + } + const targetVideoAuthorPubkey = this.getVideoAuthorPubkeyForOutput(); + if (targetVideoAuthorPubkey) { + target.videoAuthorPubkey = targetVideoAuthorPubkey; + } + if (this.parentCommentId) { + if (this.parentCommentKind) { + target.parentCommentKind = this.parentCommentKind; + } + if (this.parentCommentPubkey) { + target.parentCommentPubkey = this.parentCommentPubkey; + } + } + let events = []; try { - events = await this.fetchVideoComments(target, { + events = await this.fetchThread(target, { limit: fetchLimit, relays: this.activeRelays, }); @@ -194,6 +258,248 @@ export default class CommentThreadService { return this.getSnapshot(); } + async fetchThread(target, options = {}) { + const fallbackFetch = async (overrideOptions = options) => { + if (typeof this.fetchVideoComments !== "function") { + return []; + } + return await this.fetchVideoComments(target, overrideOptions); + }; + + if (!FEATURE_IMPROVED_COMMENT_FETCHING) { + return fallbackFetch(options); + } + + const targetCandidate = + target && typeof target === "object" ? target : {}; + const videoEventId = normalizeString( + targetCandidate.videoEventId || targetCandidate.eventId, + ); + + if (!videoEventId) { + return fallbackFetch(options); + } + + const cached = this.getCachedComments(videoEventId); + if (Array.isArray(cached)) { + return cached; + } + + const fetchOptions = { + ...options, + since: 0, + }; + + if (Number.isFinite(options?.limit)) { + fetchOptions.limit = Math.max( + toPositiveInteger(options.limit, this.defaultLimit), + this.defaultLimit, + ); + } else if (!Number.isFinite(fetchOptions.limit)) { + fetchOptions.limit = Math.max(this.defaultLimit, 100); + } + + const comments = await fallbackFetch(fetchOptions); + this.cacheComments(videoEventId, comments); + return comments; + } + + getCommentCacheKey(videoEventId) { + const normalized = normalizeString(videoEventId); + return normalized ? `${COMMENT_CACHE_PREFIX}${normalized}` : ""; + } + + getCachedComments(videoEventId) { + if ( + !FEATURE_IMPROVED_COMMENT_FETCHING || + typeof localStorage === "undefined" + ) { + return null; + } + + const cacheKey = this.getCommentCacheKey(videoEventId); + if (!cacheKey) { + return null; + } + + let raw = null; + try { + raw = localStorage.getItem(cacheKey); + } catch (error) { + if (this.logger?.warn) { + this.logger.warn( + `[commentThread] Failed to read cached comments for ${videoEventId}:`, + error, + ); + } + return null; + } + + if (raw === null) { + return null; + } + + try { + const parsed = JSON.parse(raw); + if (!parsed || typeof parsed !== "object") { + this.removeCommentCache(cacheKey); + return null; + } + + const cacheVersion = Number.isFinite(parsed.version) + ? Number(parsed.version) + : null; + + if (cacheVersion !== COMMENT_CACHE_VERSION) { + this.removeCommentCache(cacheKey); + return null; + } + + const comments = Array.isArray(parsed.comments) + ? parsed.comments + : null; + const timestamp = Number(parsed.timestamp); + + if ( + Array.isArray(comments) && + Number.isFinite(timestamp) && + Date.now() - timestamp <= COMMENT_CACHE_TTL_MS + ) { + if (devLogger?.info) { + devLogger.info( + `[commentThread] Loaded ${comments.length} cached comments for ${videoEventId}.`, + ); + } + return comments; + } + + this.removeCommentCache(cacheKey); + } catch (error) { + if (this.logger?.warn) { + this.logger.warn( + `[commentThread] Failed to parse cached comments for ${videoEventId}:`, + error, + ); + } + this.removeCommentCache(cacheKey); + } + + return null; + } + + cacheComments(videoEventId, comments) { + if ( + !FEATURE_IMPROVED_COMMENT_FETCHING || + typeof localStorage === "undefined" || + !Array.isArray(comments) + ) { + return; + } + + const cacheKey = this.getCommentCacheKey(videoEventId); + if (!cacheKey) { + return; + } + + try { + localStorage.setItem( + cacheKey, + JSON.stringify({ + version: COMMENT_CACHE_VERSION, + comments, + timestamp: Date.now(), + }), + ); + if (devLogger?.info) { + devLogger.info( + `[commentThread] Cached ${comments.length} comments for ${videoEventId}.`, + ); + } + } catch (error) { + if (this.logger?.warn) { + this.logger.warn( + `[commentThread] Failed to cache comments for ${videoEventId}:`, + error, + ); + } + } + } + + removeCommentCache(cacheKey) { + if (!cacheKey || typeof localStorage === "undefined") { + return; + } + + try { + localStorage.removeItem(cacheKey); + } catch (error) { + if (this.logger?.warn) { + this.logger.warn( + `[commentThread] Failed to clear cached comments for ${cacheKey}:`, + error, + ); + } + } + } + + clearCommentCache(videoEventId = null) { + if (!FEATURE_IMPROVED_COMMENT_FETCHING || typeof localStorage === "undefined") { + return; + } + + if (videoEventId) { + this.removeCommentCache(this.getCommentCacheKey(videoEventId)); + return; + } + + try { + const keys = Object.keys(localStorage); + keys + .filter((key) => key.startsWith(COMMENT_CACHE_PREFIX)) + .forEach((key) => this.removeCommentCache(key)); + } catch (error) { + if (this.logger?.warn) { + this.logger.warn( + "[commentThread] Failed to clear comment cache:", + error, + ); + } + } + } + + persistCommentCache() { + if (!FEATURE_IMPROVED_COMMENT_FETCHING || !this.videoEventId) { + return; + } + + const comments = this.serializeCommentsForCache(); + this.cacheComments(this.videoEventId, comments); + } + + serializeCommentsForCache() { + const events = Array.from(this.eventsById.values()); + return events.sort((a, b) => { + const aTime = Number.isFinite(a?.created_at) ? a.created_at : 0; + const bTime = Number.isFinite(b?.created_at) ? b.created_at : 0; + if (aTime !== bTime) { + return aTime - bTime; + } + + const aId = normalizeString(a?.id); + const bId = normalizeString(b?.id); + if (aId && bId) { + return aId.localeCompare(bId); + } + if (aId) { + return -1; + } + if (bId) { + return 1; + } + return 0; + }); + } + startSubscription(target) { if (typeof this.subscribeVideoComments !== "function") { return; @@ -235,6 +541,11 @@ export default class CommentThreadService { if (!isInitial && result.type === "insert") { this.emitAppend(result); + return; + } + + if (!isInitial && result.type === "update") { + this.persistCommentCache(); } } @@ -252,6 +563,15 @@ export default class CommentThreadService { const parentKey = toParentKey(parentId); const createdAt = Number.isFinite(event.created_at) ? event.created_at : 0; const pubkey = normalizePubkey(event.pubkey); + if (this.parentCommentId && eventId === this.parentCommentId) { + const kindValue = normalizeKind(event.kind); + if (kindValue) { + this.parentCommentKind = kindValue; + } + if (pubkey) { + this.parentCommentPubkey = pubkey; + } + } const existingMeta = this.metaById.get(eventId); this.eventsById.set(eventId, event); @@ -451,28 +771,44 @@ export default class CommentThreadService { await hydrationPromise; } + getVideoAuthorPubkeyForOutput() { + return this.videoAuthorPubkeyRaw || this.videoAuthorPubkey || ""; + } + emitThreadReady() { const payload = { videoEventId: this.videoEventId, parentCommentId: this.parentCommentId || null, + videoDefinitionAddress: this.videoAddressPointer || null, + videoKind: this.videoKind || null, + videoAuthorPubkey: this.getVideoAuthorPubkeyForOutput() || null, + parentCommentKind: this.parentCommentKind || null, + parentCommentPubkey: this.parentCommentPubkey || null, topLevelIds: this.getCommentIdsForParent(null), commentsById: this.cloneCommentsMap(), childrenByParent: this.cloneTreeMap(), profiles: this.getProfilesSnapshot(), }; safeCall(this.callbacks.onThreadReady, payload); + this.persistCommentCache(); } emitAppend({ parentId, eventId }) { const payload = { videoEventId: this.videoEventId, parentCommentId: parentId || null, + videoDefinitionAddress: this.videoAddressPointer || null, + videoKind: this.videoKind || null, + videoAuthorPubkey: this.getVideoAuthorPubkeyForOutput() || null, + parentCommentKind: this.parentCommentKind || null, + parentCommentPubkey: this.parentCommentPubkey || null, commentIds: [eventId], commentsById: this.cloneCommentsMap(), childrenByParent: this.cloneTreeMap(), profiles: this.getProfilesSnapshot(), }; safeCall(this.callbacks.onCommentsAppended, payload); + this.persistCommentCache(); } emitError(error) { @@ -486,6 +822,11 @@ export default class CommentThreadService { return { videoEventId: this.videoEventId, parentCommentId: this.parentCommentId || null, + videoDefinitionAddress: this.videoAddressPointer || null, + videoKind: this.videoKind || null, + videoAuthorPubkey: this.getVideoAuthorPubkeyForOutput() || null, + parentCommentKind: this.parentCommentKind || null, + parentCommentPubkey: this.parentCommentPubkey || null, commentsById: this.cloneCommentsMap(), childrenByParent: this.cloneTreeMap(), profiles: this.getProfilesSnapshot(), @@ -533,6 +874,14 @@ export default class CommentThreadService { return Array.isArray(list) ? [...list] : []; } + getCommentEvent(commentId) { + const normalized = normalizeString(commentId); + if (!normalized) { + return null; + } + return this.eventsById.get(normalized) || null; + } + waitForProfileHydration() { return this.profileHydrationPromise || Promise.resolve(); } diff --git a/js/services/discussionCountService.js b/js/services/discussionCountService.js index 445bee7e..6ddca0e2 100644 --- a/js/services/discussionCountService.js +++ b/js/services/discussionCountService.js @@ -1,5 +1,6 @@ import { devLogger } from "../utils/logger.js"; import { buildVideoAddressPointer } from "../utils/videoPointer.js"; +import { COMMENT_EVENT_KIND } from "../nostr/commentEvents.js"; const DEFAULT_MAX_DISCUSSION_COUNT_VIDEOS = 24; const COUNT_UNSUPPORTED_TITLE = "Relay does not support NIP-45 COUNT queries."; @@ -130,12 +131,57 @@ export default class DiscussionCountService { const filters = []; const eventId = typeof video.id === "string" ? video.id.trim() : ""; if (eventId) { - filters.push({ kinds: [1], "#e": [eventId] }); + filters.push({ kinds: [COMMENT_EVENT_KIND], "#e": [eventId] }); } const address = buildVideoAddressPointer(video); + const rootIdentifier = + typeof video.videoRootId === "string" ? video.videoRootId.trim() : ""; + + const uppercaseFilter = { kinds: [COMMENT_EVENT_KIND] }; + let hasUppercasePointer = false; + + if (rootIdentifier) { + uppercaseFilter["#I"] = [rootIdentifier]; + hasUppercasePointer = true; + } else if (address) { + uppercaseFilter["#A"] = [address]; + hasUppercasePointer = true; + } else if (eventId) { + uppercaseFilter["#E"] = [eventId]; + hasUppercasePointer = true; + } + + const rootKind = (() => { + if (Number.isFinite(video.kind)) { + return String(Math.floor(video.kind)); + } + if (typeof video.kind === "string" && video.kind.trim()) { + const parsed = Number(video.kind); + if (Number.isFinite(parsed)) { + return String(Math.floor(parsed)); + } + return video.kind.trim(); + } + return ""; + })(); + + if (rootKind) { + uppercaseFilter["#K"] = [rootKind]; + } + + const rootAuthor = + typeof video.pubkey === "string" ? video.pubkey.trim() : ""; + if (rootAuthor) { + uppercaseFilter["#P"] = [rootAuthor]; + } + + if (hasUppercasePointer) { + filters.push(uppercaseFilter); + } + if (address) { - filters.push({ kinds: [1], "#a": [address] }); + filters.push({ kinds: [COMMENT_EVENT_KIND], "#a": [address] }); } return filters; diff --git a/js/services/hashtagPreferencesService.js b/js/services/hashtagPreferencesService.js index ee474b3d..6cf488d3 100644 --- a/js/services/hashtagPreferencesService.js +++ b/js/services/hashtagPreferencesService.js @@ -102,6 +102,16 @@ function normalizeTag(input) { return trimmed.toLowerCase(); } +function normalizeEncryptionToken(value) { + if (typeof value !== "string") { + return ""; + } + return value + .trim() + .toLowerCase() + .replace(/[^a-z0-9]/g, ""); +} + function extractEncryptionHints(event) { if (!event || typeof event !== "object") { return []; @@ -131,16 +141,18 @@ function extractEncryptionHints(event) { } const parts = rawValue .split(/[\s,]+/) - .map((part) => part.trim().toLowerCase()) + .map((part) => normalizeEncryptionToken(part)) .filter(Boolean); for (const part of parts) { - if (part.startsWith("nip44")) { - if (/^nip44(?:[_-]?v2|v2)/.test(part)) { - pushUnique("nip44_v2"); - } else { - pushUnique("nip44"); - } - } else if (part === "nip04" || part === "nip-04") { + if (part === "nip44v2" || part === "nip44v02") { + pushUnique("nip44_v2"); + continue; + } + if (part === "nip44") { + pushUnique("nip44"); + continue; + } + if (part === "nip04" || part === "nip4") { pushUnique("nip04"); } } @@ -171,7 +183,7 @@ function determineDecryptionOrder(event, availableSchemes) { } } - for (const fallback of ["nip04", "nip44", "nip44_v2"]) { + for (const fallback of ["nip44_v2", "nip44", "nip04"]) { if (availableSet.has(fallback) && !prioritized.includes(fallback)) { prioritized.push(fallback); } diff --git a/js/services/moderationActionController.js b/js/services/moderationActionController.js new file mode 100644 index 00000000..9b88e8c1 --- /dev/null +++ b/js/services/moderationActionController.js @@ -0,0 +1,557 @@ +import { devLogger } from "../utils/logger.js"; + +export default class ModerationActionController { + constructor({ + services = {}, + selectors = {}, + actions = {}, + auth = {}, + ui = {}, + } = {}) { + this.services = { + setModerationOverride: + typeof services.setModerationOverride === "function" + ? services.setModerationOverride + : null, + clearModerationOverride: + typeof services.clearModerationOverride === "function" + ? services.clearModerationOverride + : null, + userBlocks: + services.userBlocks && typeof services.userBlocks === "object" + ? services.userBlocks + : null, + }; + + this.selectors = { + getVideoById: + typeof selectors.getVideoById === "function" + ? selectors.getVideoById + : null, + getCurrentVideo: + typeof selectors.getCurrentVideo === "function" + ? selectors.getCurrentVideo + : null, + }; + + this.actions = { + decorateVideoModeration: + typeof actions.decorateVideoModeration === "function" + ? actions.decorateVideoModeration + : null, + resumePlayback: + typeof actions.resumePlayback === "function" + ? actions.resumePlayback + : null, + refreshVideos: + typeof actions.refreshVideos === "function" + ? actions.refreshVideos + : null, + showStatus: + typeof actions.showStatus === "function" ? actions.showStatus : null, + showError: + typeof actions.showError === "function" ? actions.showError : null, + describeBlockError: + typeof actions.describeBlockError === "function" + ? actions.describeBlockError + : null, + }; + + this.auth = { + isLoggedIn: + typeof auth.isLoggedIn === "function" ? auth.isLoggedIn : null, + getViewerPubkey: + typeof auth.getViewerPubkey === "function" + ? auth.getViewerPubkey + : null, + normalizePubkey: + typeof auth.normalizePubkey === "function" + ? auth.normalizePubkey + : null, + }; + + this.ui = { + refreshCardModerationUi: + typeof ui.refreshCardModerationUi === "function" + ? ui.refreshCardModerationUi + : null, + dispatchModerationEvent: + typeof ui.dispatchModerationEvent === "function" + ? ui.dispatchModerationEvent + : null, + }; + + this.destroyed = false; + } + + destroy() { + this.destroyed = true; + } + + handleOverride({ video, card } = {}) { + if (this.destroyed) { + return false; + } + + if (!video || typeof video !== "object" || !video.id) { + return false; + } + + this.persistModerationOverride(video.id); + + const target = this.resolveTargetVideo(video); + this.clearHideState(target); + this.decorateVideo(target); + + const current = this.getCurrentVideo(); + if (current && current.id === video.id) { + this.clearHideState(current); + this.decorateVideo(current); + } + + this.refreshCard(card, { reason: "" }); + this.dispatchModerationEvent("video:moderation-override", { video: target }); + + if (target) { + this.resumePlayback(target); + } + + return true; + } + + async handleBlock({ video, card } = {}) { + if (this.destroyed) { + return false; + } + + if (!video || typeof video !== "object" || !video.id) { + return false; + } + + const { userBlocks } = this.services; + if (!userBlocks) { + devLogger.warn( + "[ModerationActionController] Block action requested but userBlocks service is unavailable.", + ); + return false; + } + + if (!this.isUserLoggedIn()) { + this.showStatus("Log in to block accounts.", { showSpinner: false }); + return false; + } + + const viewerHex = this.getViewerHex(); + if (!viewerHex) { + this.showError("Select a profile before blocking accounts."); + return false; + } + + const targetHex = this.getTargetHex(video); + if (!targetHex) { + this.showError("Unable to determine which account to block."); + return false; + } + + if (viewerHex === targetHex) { + this.showError("You cannot block yourself."); + return false; + } + + try { + await userBlocks.ensureLoaded(viewerHex); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to load block list before blocking:", + error, + ); + this.showError("Unable to load your block list. Please try again."); + return false; + } + + let alreadyBlocked = + typeof userBlocks.isBlocked === "function" && + userBlocks.isBlocked(targetHex); + let blockApplied = false; + + if (!alreadyBlocked) { + try { + const result = await userBlocks.addBlock(targetHex, viewerHex); + alreadyBlocked = true; + blockApplied = result?.already !== true; + } catch (error) { + const message = + this.describeBlockError(error) || + "Failed to block this creator. Please try again."; + this.showError(message); + devLogger.warn( + "[ModerationActionController] Failed to block creator:", + error, + ); + return false; + } + } + + if (alreadyBlocked) { + const statusMessage = blockApplied + ? "Creator blocked. Their videos will disappear from your feed." + : "Creator already blocked. Their videos will disappear from your feed."; + this.showStatus(statusMessage, { showSpinner: false }); + } + + this.clearModerationOverride(video.id); + + const target = this.resolveTargetVideo(video); + this.clearViewerOverride(target); + this.clearHideBypass(target); + this.decorateVideo(target); + + const current = this.getCurrentVideo(); + if (current && current.id === video.id) { + this.clearViewerOverride(current); + this.clearHideBypass(current); + this.decorateVideo(current); + } + + this.refreshCard(card, { reason: "after block" }); + + const detail = { video: target }; + this.dispatchModerationEvent("video:moderation-block", detail); + this.dispatchModerationEvent("video:moderation-hide", detail); + + await this.refreshVideosAfterBlock(); + + return true; + } + + handleHide({ video, card } = {}) { + if (this.destroyed) { + return false; + } + + if (!video || typeof video !== "object" || !video.id) { + return false; + } + + this.clearModerationOverride(video.id); + + const target = this.resolveTargetVideo(video); + this.clearViewerOverride(target); + this.decorateVideo(target); + + const current = this.getCurrentVideo(); + if (current && current.id === video.id) { + this.clearViewerOverride(current); + this.decorateVideo(current); + } + + this.refreshCard(card, { reason: "after hide" }); + this.dispatchModerationEvent("video:moderation-hide", { video: target }); + + return true; + } + + resolveTargetVideo(video) { + if (!video || typeof video !== "object" || !video.id) { + return null; + } + + if (!this.selectors.getVideoById) { + return video; + } + + try { + const stored = this.selectors.getVideoById(video.id); + return stored || video; + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to resolve video by id:", + error, + ); + return video; + } + } + + getCurrentVideo() { + if (!this.selectors.getCurrentVideo) { + return null; + } + + try { + return this.selectors.getCurrentVideo(); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to resolve current video:", + error, + ); + return null; + } + } + + clearHideState(video) { + const moderation = this.getModerationState(video); + if (!moderation) { + return; + } + + if (moderation.hidden) { + delete moderation.hidden; + } + if (moderation.hideReason) { + delete moderation.hideReason; + } + if (moderation.hideCounts) { + delete moderation.hideCounts; + } + if (moderation.hideBypass) { + delete moderation.hideBypass; + } + } + + clearViewerOverride(video) { + const moderation = this.getModerationState(video); + if (moderation?.viewerOverride) { + delete moderation.viewerOverride; + } + } + + clearHideBypass(video) { + const moderation = this.getModerationState(video); + if (moderation?.hideBypass) { + delete moderation.hideBypass; + } + } + + getModerationState(video) { + if (!video || typeof video !== "object") { + return null; + } + + const moderation = video.moderation; + if (!moderation || typeof moderation !== "object") { + return null; + } + + return moderation; + } + + decorateVideo(video) { + if (!video || !this.actions.decorateVideoModeration) { + return; + } + + try { + this.actions.decorateVideoModeration(video); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to decorate video moderation:", + error, + ); + } + } + + refreshCard(card, { reason } = {}) { + if (!card) { + return; + } + + if (this.ui.refreshCardModerationUi) { + this.ui.refreshCardModerationUi(card, { reason }); + return; + } + + if (typeof card.refreshModerationUi === "function") { + try { + card.refreshModerationUi(); + } catch (error) { + const suffix = reason ? ` ${reason}` : ""; + devLogger.warn( + `[ModerationActionController] Failed to refresh moderation UI${suffix}:`, + error, + ); + } + } + } + + dispatchModerationEvent(eventName, detail = {}) { + if (this.ui.dispatchModerationEvent) { + this.ui.dispatchModerationEvent(eventName, detail); + return; + } + + const doc = + typeof document !== "undefined" && document + ? document + : null; + if (!doc || typeof doc.dispatchEvent !== "function") { + return; + } + + try { + doc.dispatchEvent(new CustomEvent(eventName, { detail })); + } catch (error) { + devLogger.warn( + `[ModerationActionController] Failed to dispatch ${eventName}:`, + error, + ); + } + } + + resumePlayback(video) { + if (!video || !this.actions.resumePlayback) { + return; + } + + try { + this.actions.resumePlayback(video); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to resume moderated playback:", + error, + ); + } + } + + async refreshVideosAfterBlock() { + if (!this.actions.refreshVideos) { + return; + } + + try { + await this.actions.refreshVideos({ reason: "user-block-update" }); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to refresh videos after block:", + error, + ); + } + } + + persistModerationOverride(eventId) { + if (!eventId || !this.services.setModerationOverride) { + return; + } + + try { + this.services.setModerationOverride(eventId, { + showAnyway: true, + updatedAt: Date.now(), + }); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to persist moderation override:", + error, + ); + } + } + + clearModerationOverride(eventId) { + if (!eventId || !this.services.clearModerationOverride) { + return; + } + + try { + this.services.clearModerationOverride(eventId); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to clear moderation override:", + error, + ); + } + } + + isUserLoggedIn() { + if (!this.auth.isLoggedIn) { + return false; + } + + try { + return this.auth.isLoggedIn(); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to evaluate login state:", + error, + ); + return false; + } + } + + getViewerHex() { + if (!this.auth.getViewerPubkey || !this.auth.normalizePubkey) { + return null; + } + + try { + const pubkey = this.auth.getViewerPubkey(); + return pubkey ? this.auth.normalizePubkey(pubkey) : null; + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to resolve viewer pubkey:", + error, + ); + return null; + } + } + + getTargetHex(video) { + if (!video || !this.auth.normalizePubkey) { + return null; + } + + try { + return this.auth.normalizePubkey(video?.pubkey); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to normalize target pubkey:", + error, + ); + return null; + } + } + + showStatus(message, options) { + if (!this.actions.showStatus) { + return; + } + + try { + this.actions.showStatus(message, options); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to show status message:", + error, + ); + } + } + + showError(message) { + if (!this.actions.showError) { + return; + } + + try { + this.actions.showError(message); + } catch (error) { + devLogger.warn( + "[ModerationActionController] Failed to show error message:", + error, + ); + } + } + + describeBlockError(error) { + if (!this.actions.describeBlockError) { + return ""; + } + + try { + return this.actions.describeBlockError(error); + } catch (describeError) { + devLogger.warn( + "[ModerationActionController] Failed to describe block error:", + describeError, + ); + return ""; + } + } +} diff --git a/js/services/moderationService.js b/js/services/moderationService.js index f6cfae75..338c89df 100644 --- a/js/services/moderationService.js +++ b/js/services/moderationService.js @@ -2095,7 +2095,13 @@ export class ModerationService { return Number.isFinite(entry.trusted) ? entry.trusted : 0; } - async submitReport({ eventId, type, targetPubkey = "", content = "" } = {}) { + async submitReport({ + eventId, + type, + targetPubkey = "", + relayHint = "", + content = "", + } = {}) { const normalizedEventId = normalizeEventId(eventId); if (!normalizedEventId) { const error = new Error("invalid-event-id"); @@ -2117,6 +2123,13 @@ export class ModerationService { throw error; } + const normalizedTarget = normalizeHex(targetPubkey); + if (!normalizedTarget) { + const error = new Error("invalid-target-pubkey"); + error.code = "invalid-target-pubkey"; + throw error; + } + const extension = typeof window !== "undefined" ? window.nostr : null; if (!extension) { const error = new Error("nostr-extension-missing"); @@ -2137,17 +2150,20 @@ export class ModerationService { } } + const sanitizedRelayHint = + typeof relayHint === "string" ? relayHint.trim() : ""; + + const eventTag = ["e", normalizedEventId, normalizedType]; + if (sanitizedRelayHint) { + eventTag.push(sanitizedRelayHint); + } + const tags = [ - ["e", normalizedEventId, "", normalizedType], - ["report", normalizedType], + eventTag, + ["p", normalizedTarget, normalizedType], ["t", normalizedType], ]; - const normalizedTarget = normalizeHex(targetPubkey); - if (normalizedTarget) { - tags.push(["p", normalizedTarget]); - } - const event = { kind: 1984, created_at: Math.floor(Date.now() / 1000), diff --git a/js/services/videoNotePayload.js b/js/services/videoNotePayload.js index bca2ebab..653ca2b5 100644 --- a/js/services/videoNotePayload.js +++ b/js/services/videoNotePayload.js @@ -85,13 +85,31 @@ function normalizeImetaVariant(variant) { } const normalized = {}; const m = normalizeString(variant.m); - if (m) normalized.m = m; + if (m) normalized.m = m.toLowerCase(); const dim = normalizeString(variant.dim); if (dim) normalized.dim = dim; const url = normalizeString(variant.url); if (url) normalized.url = url; const x = normalizeString(variant.x); if (x) normalized.x = x; + const durationValue = parseNumberOrNull(variant.duration); + if (durationValue !== null && durationValue >= 0) { + normalized.duration = durationValue; + } else { + const durationString = normalizeString(variant.duration); + if (durationString) { + normalized.duration = durationString; + } + } + const bitrateValue = parseNumberOrNull(variant.bitrate); + if (bitrateValue !== null && bitrateValue >= 0) { + normalized.bitrate = bitrateValue; + } else { + const bitrateString = normalizeString(variant.bitrate); + if (bitrateString) { + normalized.bitrate = bitrateString; + } + } const image = normalizeStringArray(variant.image); if (image.length) normalized.image = image; const fallback = normalizeStringArray(variant.fallback); @@ -241,6 +259,14 @@ function normalizeNip71Metadata(rawMetadata) { : []; if (imeta.length) { normalized.imeta = imeta; + if (normalized.duration === undefined) { + const variantDurations = imeta + .map((variant) => parseNumberOrNull(variant.duration)) + .filter((value) => value !== null && value >= 0); + if (variantDurations.length) { + normalized.duration = Math.max(...variantDurations); + } + } } const textTracks = normalizeTextTracks(rawMetadata.textTracks); @@ -331,7 +357,9 @@ export function normalizeVideoNotePayload(input) { (variant.dim && variant.dim.length) || (Array.isArray(variant.image) && variant.image.length > 0) || (Array.isArray(variant.fallback) && variant.fallback.length > 0) || - (Array.isArray(variant.service) && variant.service.length > 0), + (Array.isArray(variant.service) && variant.service.length > 0) || + (variant.duration !== undefined && variant.duration !== null && variant.duration !== "") || + (variant.bitrate !== undefined && variant.bitrate !== null && variant.bitrate !== ""), ), ), ); diff --git a/js/subscriptions.js b/js/subscriptions.js index 92a96f92..f8e27c3a 100644 --- a/js/subscriptions.js +++ b/js/subscriptions.js @@ -14,7 +14,9 @@ import { import { DEFAULT_RELAY_URLS } from "./nostr/toolkit.js"; import { buildSubscriptionListEvent, - SUBSCRIPTION_LIST_IDENTIFIER + SUBSCRIPTION_LIST_IDENTIFIER, + getNostrEventSchema, + NOTE_TYPES, } from "./nostrEventSchemas.js"; import { getSidebarLoadingMarkup } from "./sidebarLoading.js"; import { @@ -28,6 +30,10 @@ import { devLogger, userLogger } from "./utils/logger.js"; import moderationService from "./services/moderationService.js"; import nostrService from "./services/nostrService.js"; +const SUBSCRIPTION_SET_KIND = + getNostrEventSchema(NOTE_TYPES.SUBSCRIPTION_LIST)?.kind ?? 30000; +const LEGACY_SUBSCRIPTION_SET_KIND = 30002; + function normalizeHexPubkey(value) { if (typeof value !== "string") { return ""; @@ -36,6 +42,16 @@ function normalizeHexPubkey(value) { return trimmed ? trimmed.toLowerCase() : ""; } +function normalizeEncryptionToken(value) { + if (typeof value !== "string") { + return ""; + } + return value + .trim() + .toLowerCase() + .replace(/[^a-z0-9]/g, ""); +} + function extractEncryptionHints(event) { if (!event || typeof event !== "object") { return []; @@ -65,16 +81,18 @@ function extractEncryptionHints(event) { } const parts = rawValue .split(/[\s,]+/) - .map((part) => part.trim().toLowerCase()) + .map((part) => normalizeEncryptionToken(part)) .filter(Boolean); for (const part of parts) { - if (part.startsWith("nip44")) { - if (/^nip44(?:[_-]?v2|v2)/.test(part)) { - pushUnique("nip44_v2"); - } else { - pushUnique("nip44"); - } - } else if (part === "nip04" || part === "nip-04") { + if (part === "nip44v2" || part === "nip44v02") { + pushUnique("nip44_v2"); + continue; + } + if (part === "nip44") { + pushUnique("nip44"); + continue; + } + if (part === "nip04" || part === "nip4") { pushUnique("nip04"); } } @@ -105,7 +123,7 @@ function determineDecryptionOrder(event, availableSchemes) { } } - for (const fallback of ["nip04", "nip44", "nip44_v2"]) { + for (const fallback of ["nip44_v2", "nip44", "nip04"]) { if (availableSet.has(fallback) && !prioritized.includes(fallback)) { prioritized.push(fallback); } @@ -114,6 +132,82 @@ function determineDecryptionOrder(event, availableSchemes) { return prioritized.length ? prioritized : available; } +function serializeSubscriptionTagMatrix(values) { + const tags = []; + const seen = new Set(); + if (!values) { + return JSON.stringify(tags); + } + const iterable = Array.isArray(values) + ? values + : values instanceof Set + ? Array.from(values) + : []; + for (const candidate of iterable) { + const normalized = normalizeHexPubkey(candidate); + if (!normalized || seen.has(normalized)) { + continue; + } + seen.add(normalized); + tags.push(["p", normalized]); + } + return JSON.stringify(tags); +} + +function parseSubscriptionPlaintext(plaintext) { + if (typeof plaintext !== "string" || !plaintext) { + return []; + } + + let parsed; + try { + parsed = JSON.parse(plaintext); + } catch (error) { + devLogger.warn( + "[SubscriptionsManager] Failed to parse subscription ciphertext as JSON; treating as empty.", + error, + ); + return []; + } + + if (Array.isArray(parsed)) { + const collected = []; + const seen = new Set(); + for (const entry of parsed) { + if (!Array.isArray(entry) || entry.length < 2) { + continue; + } + const marker = typeof entry[0] === "string" ? entry[0].trim().toLowerCase() : ""; + if (marker !== "p") { + continue; + } + const normalized = normalizeHexPubkey(entry[1]); + if (!normalized || seen.has(normalized)) { + continue; + } + seen.add(normalized); + collected.push(normalized); + } + return collected; + } + + if (parsed && typeof parsed === "object") { + const tagArray = Array.isArray(parsed.tags) ? parsed.tags : []; + if (tagArray.length) { + try { + return parseSubscriptionPlaintext(JSON.stringify(tagArray)); + } catch { + // fall through to legacy handling + } + } + + const legacy = Array.isArray(parsed.subPubkeys) ? parsed.subPubkeys : []; + return legacy.map((value) => normalizeHexPubkey(value)).filter(Boolean); + } + + return []; +} + const getApp = () => getApplication(); const listVideoViewEventsApi = (pointer, options) => @@ -122,8 +216,8 @@ const subscribeVideoViewEventsApi = (pointer, options) => subscribeVideoViewEvents(nostrClient, pointer, options); /** - * Manages the user's subscription list (kind=30002) *privately*, - * using NIP-04 encryption for the content field. + * Manages the user's subscription list (kind=30000 follow set) *privately*, + * using encrypted NIP-51 tag arrays (NIP-04/NIP-44) for the content field. * Also handles fetching and rendering subscribed channels' videos * in the same card style as your home page. */ @@ -146,7 +240,7 @@ class SubscriptionsManager { } /** - * Decrypt the subscription list from kind=30002 (d="subscriptions"). + * Decrypt the subscription list from kind=30000 (d="subscriptions"). */ async loadSubscriptions(userPubkey) { if (!userPubkey) { @@ -172,8 +266,13 @@ class SubscriptionsManager { authors.push(userPubkey); } + const subscriptionKinds = [SUBSCRIPTION_SET_KIND]; + if (!subscriptionKinds.includes(LEGACY_SUBSCRIPTION_SET_KIND)) { + subscriptionKinds.push(LEGACY_SUBSCRIPTION_SET_KIND); + } + const filter = { - kinds: [30002], + kinds: subscriptionKinds, authors, "#d": [SUBSCRIPTION_LIST_IDENTIFIER], limit: 1 @@ -283,13 +382,7 @@ class SubscriptionsManager { const decryptedStr = decryptResult.plaintext; - const parsed = JSON.parse(decryptedStr); - const subArray = Array.isArray(parsed.subPubkeys) - ? parsed.subPubkeys - : []; - const normalized = subArray - .map((value) => normalizeHexPubkey(value)) - .filter((value) => Boolean(value)); + const normalized = parseSubscriptionPlaintext(decryptedStr); this.subscribedPubkeys = new Set(normalized); this.loaded = true; @@ -484,7 +577,7 @@ class SubscriptionsManager { /** * Encrypt (NIP-04) + publish the updated subscription set - * as kind=30002 with ["d", "subscriptions"] to be replaceable. + * as kind=30000 with ["d", "subscriptions"] to be replaceable. */ async publishSubscriptionList(userPubkey) { if (!userPubkey) { @@ -516,23 +609,41 @@ class SubscriptionsManager { } } - if (typeof signer.nip04Encrypt !== "function") { - const error = new Error("NIP-04 encryption is required to update subscriptions."); - error.code = "nip04-missing"; - throw error; - } - if (typeof signer.signEvent !== "function") { const error = new Error("Active signer missing signEvent support."); error.code = "sign-event-missing"; throw error; } - const plainObj = { subPubkeys: Array.from(this.subscribedPubkeys) }; - const plainStr = JSON.stringify(plainObj); + const plainStr = serializeSubscriptionTagMatrix(this.subscribedPubkeys); + + const encryptors = []; + const registerEncryptor = (scheme, handler) => { + if (!scheme || typeof handler !== "function") { + return; + } + encryptors.push({ scheme, handler }); + }; + + if (typeof signer.nip44Encrypt === "function") { + registerEncryptor("nip44_v2", (value) => signer.nip44Encrypt(userPubkey, value)); + registerEncryptor("nip44", (value) => signer.nip44Encrypt(userPubkey, value)); + } + + if (typeof signer.nip04Encrypt === "function") { + registerEncryptor("nip04", (value) => signer.nip04Encrypt(userPubkey, value)); + } + + if (!encryptors.length) { + const error = new Error( + "An encryption-capable signer is required to update subscriptions.", + ); + error.code = "subscriptions-missing-encryptor"; + throw error; + } /* - * The subscription list is stored as a NIP-04 message to self, so both + * The subscription list is stored as an encrypted message to self, so both * encryption and decryption intentionally use the user's own pubkey. * Extensions are expected to support this encrypt-to-self flow; altering * the target would break loadSubscriptions, which decrypts with the same @@ -540,17 +651,48 @@ class SubscriptionsManager { * need a parallel read path and should not overwrite this behavior. */ let cipherText = ""; - try { - cipherText = await signer.nip04Encrypt(userPubkey, plainStr); - } catch (err) { - userLogger.error("Encryption failed:", err); - throw err; + let encryptionScheme = ""; + const seenSchemes = new Set(); + const encryptionErrors = []; + + for (const candidate of encryptors) { + if (seenSchemes.has(candidate.scheme)) { + continue; + } + seenSchemes.add(candidate.scheme); + try { + const encrypted = await candidate.handler(plainStr); + if (typeof encrypted === "string" && encrypted) { + cipherText = encrypted; + encryptionScheme = candidate.scheme; + break; + } + } catch (error) { + encryptionErrors.push({ scheme: candidate.scheme, error }); + } } + if (!cipherText) { + const error = new Error("Failed to encrypt subscription list payload."); + error.code = "subscriptions-encrypt-failed"; + error.cause = encryptionErrors; + throw error; + } + + const encryptionTagValue = + encryptionScheme === "nip44_v2" + ? "nip44_v2" + : encryptionScheme === "nip44" + ? "nip44" + : encryptionScheme === "nip04" + ? "nip04" + : undefined; + const evt = buildSubscriptionListEvent({ pubkey: userPubkey, created_at: Math.floor(Date.now() / 1000), - content: cipherText + content: cipherText, + encryption: encryptionTagValue, }); let signedEvent; @@ -1081,7 +1223,7 @@ class SubscriptionsManager { }; const assets = baseView?.assets || { - fallbackThumbnailSrc: "assets/jpg/video-thumbnail-fallback.jpg", + fallbackThumbnailSrc: "/assets/jpg/video-thumbnail-fallback.jpg", unsupportedBtihMessage: "This magnet link is missing a compatible BitTorrent v1 info hash." }; diff --git a/js/ui/ModalManager.js b/js/ui/ModalManager.js new file mode 100644 index 00000000..cc07193f --- /dev/null +++ b/js/ui/ModalManager.js @@ -0,0 +1,857 @@ +import { devLogger } from "../utils/logger.js"; +import { removeTrackingScripts, escapeHTML as escapeHtml } from "../utils/domUtils.js"; +import { setModalState as setGlobalModalState } from "../state/appState.js"; +import { truncateMiddle, formatShortNpub } from "../utils/formatters.js"; +import { showLoginRequiredToZapNotification } from "../payments/zapNotifications.js"; +import { VideoModal } from "./components/VideoModal.js"; +import { RevertModal } from "./components/RevertModal.js"; +import initUploadModal from "./initUploadModal.js"; +import initEditModal from "./initEditModal.js"; +import initDeleteModal from "./initDeleteModal.js"; +import ZapController from "./zapController.js"; +import { nostrClient } from "../nostrClientFacade.js"; + +export default class ModalManager { + constructor({ + app, + ui = {}, + documentRef = typeof document !== "undefined" ? document : null, + assets = {}, + } = {}) { + this.app = app; + this.ui = ui; + this.document = documentRef; + this.assets = { + fallbackThumbnailSrc: assets.fallbackThumbnailSrc || null, + }; + + this.uploadModal = null; + this.uploadModalEvents = null; + this.uploadSubmitHandler = null; + + this.editModal = null; + this.editModalEvents = null; + this.editSubmitHandler = null; + this.editCancelHandler = null; + + this.revertModal = null; + this.revertConfirmHandler = null; + + this.deleteModal = null; + this.deleteModalEvents = null; + this.deleteConfirmHandler = null; + this.deleteCancelHandler = null; + + this.videoModal = null; + this.videoModalHandlers = {}; + + this.zapController = null; + } + + initialize() { + const app = this.app; + const doc = this.document; + const modalContainer = doc?.getElementById("modalContainer") || null; + + const uploadModalSetup = initUploadModal({ + app, + uploadModalOverride: this.ui.uploadModal, + container: modalContainer, + services: { + authService: app.authService, + r2Service: app.r2Service, + }, + utilities: { + removeTrackingScripts, + setGlobalModalState, + }, + callbacks: { + publishVideoNote: (payload, options) => + app.publishVideoNote(payload, options), + showError: (message) => app.showError(message), + showSuccess: (message) => app.showSuccess(message), + getCurrentPubkey: () => app.pubkey, + safeEncodeNpub: (pubkey) => app.safeEncodeNpub(pubkey), + onSubmit: (event) => app.handleUploadSubmitEvent(event), + }, + }); + this.uploadModal = uploadModalSetup.modal; + this.uploadModalEvents = uploadModalSetup.events; + this.uploadSubmitHandler = uploadModalSetup.handlers.submit; + app.uploadModal = this.uploadModal; + app.uploadModalEvents = this.uploadModalEvents; + + const editModalSetup = initEditModal({ + app, + editModalOverride: this.ui.editModal, + container: modalContainer, + services: { + getMode: ({ video } = {}) => { + const candidate = + typeof video?.mode === "string" ? video.mode.trim().toLowerCase() : ""; + return candidate === "dev" ? "dev" : "live"; + }, + sanitizers: { + text: (value) => (typeof value === "string" ? value.trim() : ""), + url: (value) => (typeof value === "string" ? value.trim() : ""), + magnet: (value) => (typeof value === "string" ? value.trim() : ""), + checkbox: (value) => !!value, + }, + }, + utilities: { + removeTrackingScripts, + setGlobalModalState, + escapeHtml: (value) => escapeHtml(value), + }, + callbacks: { + showError: (message) => app.showError(message), + onSubmit: (event) => app.handleEditModalSubmit(event), + onCancel: () => app.showError(""), + }, + }); + + this.editModal = editModalSetup.modal; + this.editModalEvents = editModalSetup.events; + this.editSubmitHandler = editModalSetup.handlers.submit; + this.editCancelHandler = editModalSetup.handlers.cancel; + app.editModal = this.editModal; + app.editModalEvents = this.editModalEvents; + + this.revertModal = + (typeof this.ui.revertModal === "function" + ? this.ui.revertModal({ app }) + : this.ui.revertModal) || + new RevertModal({ + removeTrackingScripts, + setGlobalModalState, + formatAbsoluteTimestamp: (timestamp) => app.formatAbsoluteTimestamp(timestamp), + formatTimeAgo: (timestamp) => app.formatTimeAgo(timestamp), + escapeHTML: (value) => app.escapeHTML(value), + truncateMiddle, + formatShortNpub: (value) => formatShortNpub(value), + fallbackThumbnailSrc: this.assets.fallbackThumbnailSrc, + container: modalContainer, + }); + + this.revertConfirmHandler = (event) => { + app.handleRevertModalConfirm(event); + }; + this.revertModal.addEventListener( + "video:revert-confirm", + this.revertConfirmHandler, + ); + app.revertModal = this.revertModal; + + const deleteModalSetup = initDeleteModal({ + app, + deleteModalOverride: this.ui.deleteModal, + container: modalContainer, + utilities: { + removeTrackingScripts, + setGlobalModalState, + truncateMiddle, + }, + callbacks: { + onConfirm: (event) => app.handleDeleteModalConfirm(event), + onCancel: () => app.showError(""), + }, + }); + + this.deleteModal = deleteModalSetup.modal; + this.deleteModalEvents = deleteModalSetup.events; + this.deleteConfirmHandler = deleteModalSetup.handlers.confirm; + this.deleteCancelHandler = deleteModalSetup.handlers.cancel; + app.deleteModal = this.deleteModal; + app.deleteModalEvents = this.deleteModalEvents; + + this.videoModal = + (typeof this.ui.videoModal === "function" + ? this.ui.videoModal({ app }) + : this.ui.videoModal) || + new VideoModal({ + removeTrackingScripts, + setGlobalModalState, + document: doc, + logger: { + log: (message, ...args) => app.log(message, ...args), + }, + mediaLoader: app.mediaLoader, + assets: { + fallbackThumbnailSrc: this.assets.fallbackThumbnailSrc, + }, + state: { + loadedThumbnails: app.loadedThumbnails, + }, + helpers: { + safeEncodeNpub: (pubkey) => app.safeEncodeNpub(pubkey), + formatShortNpub: (value) => formatShortNpub(value), + }, + }); + + if ( + this.videoModal && + typeof this.videoModal.setMediaLoader === "function" + ) { + this.videoModal.setMediaLoader(app.mediaLoader); + } + if ( + this.videoModal && + typeof this.videoModal.setTagPreferenceStateResolver === "function" + ) { + this.videoModal.setTagPreferenceStateResolver((tag) => + app.getTagPreferenceState(tag), + ); + } + + this.zapController = new ZapController({ + videoModal: this.videoModal, + getCurrentVideo: () => app.currentVideo, + nwcSettings: app.nwcSettingsService, + isUserLoggedIn: () => app.isUserLoggedIn(), + hasSessionActor: () => + Boolean( + typeof nostrClient?.sessionActor?.pubkey === "string" && + nostrClient.sessionActor.pubkey.trim(), + ), + notifyLoginRequired: () => + showLoginRequiredToZapNotification({ + app, + document: app.statusContainer?.ownerDocument || doc, + }), + splitAndZap: (...args) => app.splitAndZap(...args), + payments: app.payments, + callbacks: { + onSuccess: (message) => app.showSuccess(message), + onError: (message) => app.showError(message), + }, + requestWalletPane: () => app.openWalletPane(), + }); + app.zapController = this.zapController; + + this.videoModalHandlers.close = () => { + app.hideModal(); + }; + this.videoModal.addEventListener( + "modal:close", + this.videoModalHandlers.close, + ); + + this.videoModalHandlers.copy = () => { + app.handleCopyMagnet(); + }; + this.videoModal.addEventListener( + "video:copy-magnet", + this.videoModalHandlers.copy, + ); + + this.videoModalHandlers.share = () => { + app.shareActiveVideo(); + }; + this.videoModal.addEventListener( + "video:share", + this.videoModalHandlers.share, + ); + + this.videoModalHandlers.moderationOverride = (event) => { + const detail = event?.detail || {}; + const targetVideo = + detail && typeof detail.video === "object" + ? detail.video + : app.currentVideo || null; + if (!targetVideo) { + const trigger = detail?.trigger; + if (trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + return; + } + + const handled = app.handleModerationOverride({ + video: targetVideo, + card: detail?.card || null, + }); + + if (handled === false) { + const trigger = detail?.trigger; + if (trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + } + }; + this.videoModal.addEventListener( + "video:moderation-override", + this.videoModalHandlers.moderationOverride, + ); + + this.videoModalHandlers.moderationBlock = (event) => { + const detail = event?.detail || {}; + const targetVideo = + detail && typeof detail.video === "object" + ? detail.video + : app.currentVideo || null; + const trigger = detail?.trigger || null; + + if (!targetVideo) { + if (trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + return; + } + + Promise.resolve( + app.handleModerationBlock({ + video: targetVideo, + card: detail?.card || null, + }), + ) + .then((handled) => { + if (handled === false && trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + }) + .catch((error) => { + devLogger.warn( + "[Application] Failed to handle modal moderation block:", + error, + ); + if (trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + }); + }; + this.videoModal.addEventListener( + "video:moderation-block", + this.videoModalHandlers.moderationBlock, + ); + + this.videoModalHandlers.moderationHide = (event) => { + const detail = event?.detail || {}; + const targetVideo = + detail && typeof detail.video === "object" + ? detail.video + : app.currentVideo || null; + const trigger = detail?.trigger || null; + + if (!targetVideo) { + if (trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + return; + } + + Promise.resolve( + app.handleModerationHide({ + video: targetVideo, + card: detail?.card || null, + }), + ) + .then((handled) => { + if (handled === false && trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + }) + .catch((error) => { + devLogger.warn( + "[Application] Failed to handle modal moderation hide:", + error, + ); + if (trigger) { + trigger.disabled = false; + trigger.removeAttribute("aria-busy"); + } + }); + }; + this.videoModal.addEventListener( + "video:moderation-hide", + this.videoModalHandlers.moderationHide, + ); + + this.videoModalHandlers.tagActivate = (event) => { + const detail = event?.detail || {}; + const nativeEvent = detail?.nativeEvent || null; + if (nativeEvent) { + nativeEvent.preventDefault?.(); + nativeEvent.stopPropagation?.(); + } + + app.handleTagPreferenceActivation({ + tag: detail?.tag, + trigger: detail?.trigger || null, + context: "modal", + video: detail?.video || app.currentVideo || null, + event: nativeEvent, + }); + }; + this.videoModal.addEventListener( + "tag:activate", + this.videoModalHandlers.tagActivate, + ); + + this.videoModalHandlers.similarSelect = (event) => { + const detail = event?.detail || {}; + const selectedVideo = + detail && typeof detail.video === "object" ? detail.video : null; + const triggerCandidate = + detail?.event?.currentTarget || + (detail?.card && typeof detail.card.getRoot === "function" + ? detail.card.getRoot() + : null); + + app.setLastModalTrigger(triggerCandidate || null); + + if (detail?.event) { + detail.event.preventDefault?.(); + detail.event.stopPropagation?.(); + } + + if (!selectedVideo) { + return; + } + + const playbackOptions = { + trigger: triggerCandidate || null, + }; + + const rawUrl = + typeof selectedVideo.url === "string" ? selectedVideo.url.trim() : ""; + if (rawUrl) { + playbackOptions.url = rawUrl; + } + + const rawMagnet = + typeof selectedVideo.magnet === "string" + ? selectedVideo.magnet.trim() + : ""; + if (rawMagnet) { + playbackOptions.magnet = rawMagnet; + } + + const hasPlayById = typeof app.playVideoByEventId === "function"; + const hasFallbackPlayback = + typeof app.playVideoWithFallback === "function"; + + const selectedId = + typeof selectedVideo.id === "string" ? selectedVideo.id : ""; + + if (selectedId && hasPlayById) { + Promise.resolve(app.playVideoByEventId(selectedId, playbackOptions)).catch( + (error) => { + devLogger.error( + "[ModalManager] Failed to play selected similar video:", + error, + ); + }, + ); + return; + } + + if (!hasFallbackPlayback) { + devLogger.warn( + "[ModalManager] Unable to start playback for similar video; no playback handler is available.", + ); + return; + } + + Promise.resolve(app.playVideoWithFallback(playbackOptions)).catch( + (error) => { + devLogger.error( + "[ModalManager] Failed to start playback for similar video:", + error, + ); + }, + ); + }; + this.videoModal.addEventListener( + "similar:select", + this.videoModalHandlers.similarSelect, + ); + + this.videoModalHandlers.reaction = (event) => { + const detail = event?.detail || {}; + app.handleVideoReaction(detail); + }; + this.videoModal.addEventListener( + "video:reaction", + this.videoModalHandlers.reaction, + ); + + this.videoModalHandlers.contextAction = (event) => { + const detail = event?.detail || {}; + const action = typeof detail.action === "string" ? detail.action : ""; + if (!action) { + return; + } + const dataset = { + ...(detail.dataset || {}), + }; + if (!dataset.context) { + dataset.context = "modal"; + } + app.handleMoreMenuAction(action, dataset); + }; + this.videoModal.addEventListener( + "video:context-action", + this.videoModalHandlers.contextAction, + ); + + this.videoModalHandlers.creatorNavigate = () => { + app.openCreatorChannel(); + }; + this.videoModal.addEventListener( + "creator:navigate", + this.videoModalHandlers.creatorNavigate, + ); + + this.videoModalHandlers.zap = (event) => { + this.zapController?.sendZap(event?.detail || {}); + }; + this.videoModal.addEventListener( + "video:zap", + this.videoModalHandlers.zap, + ); + + this.videoModalHandlers.zapOpen = (event) => { + const requiresLogin = Boolean(event?.detail?.requiresLogin); + app.pendingModalZapOpen = requiresLogin; + + const openResult = this.zapController?.open({ requiresLogin }); + if (!openResult) { + event?.preventDefault?.(); + if (!requiresLogin) { + app.pendingModalZapOpen = false; + } + this.videoModal?.closeZapDialog?.({ + silent: true, + restoreFocus: false, + }); + return; + } + + app.pendingModalZapOpen = false; + }; + this.videoModal.addEventListener( + "zap:open", + this.videoModalHandlers.zapOpen, + ); + + this.videoModalHandlers.zapClose = () => { + this.zapController?.close(); + }; + this.videoModal.addEventListener( + "zap:close", + this.videoModalHandlers.zapClose, + ); + + this.videoModalHandlers.zapAmount = (event) => { + this.zapController?.setAmount(event?.detail?.amount); + }; + this.videoModal.addEventListener( + "zap:amount-change", + this.videoModalHandlers.zapAmount, + ); + + this.videoModalHandlers.zapComment = (event) => { + this.zapController?.setComment(event?.detail?.comment); + }; + this.videoModal.addEventListener( + "zap:comment-change", + this.videoModalHandlers.zapComment, + ); + + this.videoModalHandlers.zapWallet = () => { + this.zapController?.handleWalletLink(); + }; + this.videoModal.addEventListener( + "zap:wallet-link", + this.videoModalHandlers.zapWallet, + ); + + this.videoModalHandlers.commentSubmit = (event) => { + app.commentController?.submit(event?.detail || {}); + }; + this.videoModal.addEventListener( + "comment:submit", + this.videoModalHandlers.commentSubmit, + ); + + this.videoModalHandlers.commentRetry = (event) => { + app.commentController?.retry(event?.detail || {}); + }; + this.videoModal.addEventListener( + "comment:retry", + this.videoModalHandlers.commentRetry, + ); + + this.videoModalHandlers.commentLoadMore = () => { + app.commentController?.loadMore(); + }; + this.videoModal.addEventListener( + "comment:load-more", + this.videoModalHandlers.commentLoadMore, + ); + + this.videoModalHandlers.commentLogin = (event) => { + app.commentController?.handleLoginRequired(event?.detail || {}); + }; + this.videoModal.addEventListener( + "comment:login-required", + this.videoModalHandlers.commentLogin, + ); + + this.videoModalHandlers.commentMute = (event) => { + app.commentController?.muteAuthor(event?.detail || {}); + }; + this.videoModal.addEventListener( + "comment:mute-author", + this.videoModalHandlers.commentMute, + ); + + app.videoModal = this.videoModal; + } + + teardown() { + const app = this.app; + + if (this.uploadModal && this.uploadSubmitHandler) { + try { + this.uploadModal.removeEventListener( + "upload:submit", + this.uploadSubmitHandler, + ); + } catch (error) { + devLogger.warn("[ModalManager] Failed to remove upload submit handler:", error); + } + } + if (typeof this.uploadModal?.destroy === "function") { + try { + this.uploadModal.destroy(); + } catch (error) { + devLogger.warn("[ModalManager] Failed to destroy upload modal:", error); + } + } + + if (this.editModal) { + if (this.editSubmitHandler) { + try { + this.editModal.removeEventListener( + "video:edit-submit", + this.editSubmitHandler, + ); + } catch (error) { + devLogger.warn( + "[ModalManager] Failed to remove edit submit handler:", + error, + ); + } + } + if (this.editCancelHandler) { + try { + this.editModal.removeEventListener( + "video:edit-cancel", + this.editCancelHandler, + ); + } catch (error) { + devLogger.warn( + "[ModalManager] Failed to remove edit cancel handler:", + error, + ); + } + } + if (typeof this.editModal.destroy === "function") { + try { + this.editModal.destroy(); + } catch (error) { + devLogger.warn("[ModalManager] Failed to destroy edit modal:", error); + } + } + } + + if (this.revertModal && this.revertConfirmHandler) { + try { + this.revertModal.removeEventListener( + "video:revert-confirm", + this.revertConfirmHandler, + ); + } catch (error) { + devLogger.warn("[ModalManager] Failed to remove revert handler:", error); + } + this.revertConfirmHandler = null; + } + if (typeof this.revertModal?.destroy === "function") { + try { + this.revertModal.destroy(); + } catch (error) { + devLogger.warn("[ModalManager] Failed to destroy revert modal:", error); + } + } + + if (this.deleteModal) { + if (this.deleteConfirmHandler) { + try { + this.deleteModal.removeEventListener( + "video:delete-confirm", + this.deleteConfirmHandler, + ); + } catch (error) { + devLogger.warn( + "[ModalManager] Failed to remove delete confirm handler:", + error, + ); + } + } + if (this.deleteCancelHandler) { + try { + this.deleteModal.removeEventListener( + "video:delete-cancel", + this.deleteCancelHandler, + ); + } catch (error) { + devLogger.warn( + "[ModalManager] Failed to remove delete cancel handler:", + error, + ); + } + } + if (typeof this.deleteModal.destroy === "function") { + try { + this.deleteModal.destroy(); + } catch (error) { + devLogger.warn("[ModalManager] Failed to destroy delete modal:", error); + } + } + } + + if (this.videoModal) { + const entries = Object.entries(this.videoModalHandlers); + for (const [key, handler] of entries) { + if (!handler) { + continue; + } + let eventName = null; + switch (key) { + case "close": + eventName = "modal:close"; + break; + case "copy": + eventName = "video:copy-magnet"; + break; + case "share": + eventName = "video:share"; + break; + case "moderationOverride": + eventName = "video:moderation-override"; + break; + case "moderationBlock": + eventName = "video:moderation-block"; + break; + case "moderationHide": + eventName = "video:moderation-hide"; + break; + case "tagActivate": + eventName = "tag:activate"; + break; + case "similarSelect": + eventName = "similar:select"; + break; + case "reaction": + eventName = "video:reaction"; + break; + case "contextAction": + eventName = "video:context-action"; + break; + case "creatorNavigate": + eventName = "creator:navigate"; + break; + case "zap": + eventName = "video:zap"; + break; + case "zapOpen": + eventName = "zap:open"; + break; + case "zapClose": + eventName = "zap:close"; + break; + case "zapAmount": + eventName = "zap:amount-change"; + break; + case "zapComment": + eventName = "zap:comment-change"; + break; + case "zapWallet": + eventName = "zap:wallet-link"; + break; + case "commentSubmit": + eventName = "comment:submit"; + break; + case "commentRetry": + eventName = "comment:retry"; + break; + case "commentLoadMore": + eventName = "comment:load-more"; + break; + case "commentLogin": + eventName = "comment:login-required"; + break; + case "commentMute": + eventName = "comment:mute-author"; + break; + default: + break; + } + if (!eventName) { + continue; + } + try { + this.videoModal.removeEventListener(eventName, handler); + } catch (error) { + devLogger.warn( + `[ModalManager] Failed to remove handler for ${eventName}:`, + error, + ); + } + this.videoModalHandlers[key] = null; + } + + if (typeof this.videoModal.destroy === "function") { + try { + this.videoModal.destroy(); + } catch (error) { + devLogger.warn("[ModalManager] Failed to destroy video modal:", error); + } + } + } + + app.uploadModal = null; + app.uploadModalEvents = null; + app.editModal = null; + app.editModalEvents = null; + app.revertModal = null; + app.deleteModal = null; + app.deleteModalEvents = null; + app.videoModal = null; + app.zapController = null; + + this.uploadModal = null; + this.uploadModalEvents = null; + this.uploadSubmitHandler = null; + this.editModal = null; + this.editModalEvents = null; + this.editSubmitHandler = null; + this.editCancelHandler = null; + this.revertModal = null; + this.deleteModal = null; + this.deleteModalEvents = null; + this.deleteConfirmHandler = null; + this.deleteCancelHandler = null; + this.videoModal = null; + this.videoModalHandlers = {}; + this.zapController = null; + } +} diff --git a/js/ui/appChromeController.js b/js/ui/appChromeController.js index f8cb7467..1960bd20 100644 --- a/js/ui/appChromeController.js +++ b/js/ui/appChromeController.js @@ -16,11 +16,13 @@ export default class AppChromeController { logger, } = {}) { this.elements = { - logoutButton: elements.logoutButton || null, - profileButton: elements.profileButton || null, - uploadButton: elements.uploadButton || null, - loginButton: elements.loginButton || null, - closeLoginModalButton: elements.closeLoginModalButton || null, + logoutButton: this.normalizeElement(elements.logoutButton), + profileButton: this.normalizeElement(elements.profileButton), + uploadButton: this.normalizeElement(elements.uploadButton), + loginButton: this.normalizeElement(elements.loginButton), + closeLoginModalButton: this.normalizeElement( + elements.closeLoginModalButton, + ), }; this.callbacks = { @@ -59,42 +61,17 @@ export default class AppChromeController { this.logger = logger || defaultLogger; this.isInitialized = false; + this.hasBoundGlobalEvents = false; - this.handleBeforeUnload = this.handleBeforeUnload.bind(this); - this.handleVisibilityChange = this.handleVisibilityChange.bind(this); - this.handlePopstate = this.handlePopstate.bind(this); - this.handleDocumentClick = this.handleDocumentClick.bind(this); - } + this.boundElements = { + logoutButton: null, + profileButton: null, + uploadButton: null, + loginButton: null, + closeLoginModalButton: null, + }; - initialize() { - if (this.isInitialized) { - return; - } - - this.bindLogoutButton(); - this.bindProfileButton(); - this.bindUploadButton(); - this.bindLoginButton(); - this.bindCloseLoginButton(); - this.bindGlobalEvents(); - - this.isInitialized = true; - } - - getTriggerFromEvent(event) { - if (!event) { - return null; - } - return event.currentTarget || event.target || null; - } - - bindLogoutButton() { - const { logoutButton } = this.elements; - if (!logoutButton || typeof logoutButton.addEventListener !== "function") { - return; - } - - logoutButton.addEventListener("click", async () => { + this.handleLogoutClick = async () => { try { if (typeof this.callbacks.requestLogout === "function") { await this.callbacks.requestLogout(); @@ -107,16 +84,9 @@ export default class AppChromeController { this.callbacks.showError(DEFAULT_LOGOUT_ERROR_MESSAGE); } } - }); - } + }; - bindProfileButton() { - const { profileButton } = this.elements; - if (!profileButton || typeof profileButton.addEventListener !== "function") { - return; - } - - profileButton.addEventListener("click", () => { + this.handleProfileClick = () => { if (typeof this.callbacks.showProfileModal !== "function") { return; } @@ -128,19 +98,13 @@ export default class AppChromeController { this.logger.error("Failed to open profile modal:", error); } }); - }); - } + }; - bindUploadButton() { - const { uploadButton } = this.elements; - if (!uploadButton || typeof uploadButton.addEventListener !== "function") { - return; - } - - uploadButton.addEventListener("click", (event) => { + this.handleUploadClick = (event) => { if (typeof this.callbacks.openUploadModal !== "function") { return; } + const triggerElement = this.getTriggerFromEvent(event); try { this.callbacks.openUploadModal({ triggerElement }); @@ -149,16 +113,9 @@ export default class AppChromeController { this.logger.error("Failed to open upload modal:", error); } } - }); - } + }; - bindLoginButton() { - const { loginButton } = this.elements; - if (!loginButton || typeof loginButton.addEventListener !== "function") { - return; - } - - loginButton.addEventListener("click", (event) => { + this.handleLoginClick = (event) => { if (this.logger?.log) { this.logger.log("Login button clicked!"); } @@ -178,19 +135,9 @@ export default class AppChromeController { this.callbacks.onLoginModalOpened(); } } - }); - } + }; - bindCloseLoginButton() { - const { closeLoginModalButton } = this.elements; - if ( - !closeLoginModalButton || - typeof closeLoginModalButton.addEventListener !== "function" - ) { - return; - } - - closeLoginModalButton.addEventListener("click", () => { + this.handleCloseLoginClick = () => { if (this.logger?.log) { this.logger.log("[app.js] closeLoginModal button clicked!"); } @@ -201,7 +148,149 @@ export default class AppChromeController { this.callbacks.onLoginModalClosed(); } } - }); + }; + + this.handleBeforeUnload = this.handleBeforeUnload.bind(this); + this.handleVisibilityChange = this.handleVisibilityChange.bind(this); + this.handlePopstate = this.handlePopstate.bind(this); + this.handleDocumentClick = this.handleDocumentClick.bind(this); + } + + initialize() { + this.bindLogoutButton(); + this.bindProfileButton(); + this.bindUploadButton(); + this.bindLoginButton(); + this.bindCloseLoginButton(); + + if (!this.hasBoundGlobalEvents) { + this.bindGlobalEvents(); + this.hasBoundGlobalEvents = true; + } + + this.isInitialized = true; + } + + getTriggerFromEvent(event) { + if (!event) { + return null; + } + return event.currentTarget || event.target || null; + } + + bindLogoutButton() { + const button = this.normalizeElement(this.elements.logoutButton); + if (this.boundElements.logoutButton === button) { + return; + } + + this.detachBoundElement("logoutButton", this.handleLogoutClick); + + if (button) { + button.addEventListener("click", this.handleLogoutClick); + this.boundElements.logoutButton = button; + } + } + + bindProfileButton() { + const button = this.normalizeElement(this.elements.profileButton); + if (this.boundElements.profileButton === button) { + return; + } + + this.detachBoundElement("profileButton", this.handleProfileClick); + + if (button) { + button.addEventListener("click", this.handleProfileClick); + this.boundElements.profileButton = button; + } + } + + bindUploadButton() { + const button = this.normalizeElement(this.elements.uploadButton); + if (this.boundElements.uploadButton === button) { + return; + } + + this.detachBoundElement("uploadButton", this.handleUploadClick); + + if (button) { + button.addEventListener("click", this.handleUploadClick); + this.boundElements.uploadButton = button; + } + } + + bindLoginButton() { + const button = this.normalizeElement(this.elements.loginButton); + if (this.boundElements.loginButton === button) { + return; + } + + this.detachBoundElement("loginButton", this.handleLoginClick); + + if (button) { + button.addEventListener("click", this.handleLoginClick); + this.boundElements.loginButton = button; + } + } + + bindCloseLoginButton() { + const button = this.normalizeElement(this.elements.closeLoginModalButton); + if (this.boundElements.closeLoginModalButton === button) { + return; + } + + this.detachBoundElement("closeLoginModalButton", this.handleCloseLoginClick); + + if (button) { + button.addEventListener("click", this.handleCloseLoginClick); + this.boundElements.closeLoginModalButton = button; + } + } + + setElements(nextElements = {}) { + if (!nextElements || typeof nextElements !== "object") { + return; + } + + const keys = [ + "logoutButton", + "profileButton", + "uploadButton", + "loginButton", + "closeLoginModalButton", + ]; + + let shouldRebind = false; + + for (const key of keys) { + if (Object.prototype.hasOwnProperty.call(nextElements, key)) { + const normalized = this.normalizeElement(nextElements[key]); + if (this.elements[key] !== normalized) { + this.elements[key] = normalized; + shouldRebind = true; + } + } + } + + if (shouldRebind) { + this.initialize(); + } + } + + detachBoundElement(key, handler) { + const previous = this.boundElements[key]; + if (previous && typeof previous.removeEventListener === "function") { + previous.removeEventListener("click", handler); + } + this.boundElements[key] = null; + } + + normalizeElement(element) { + if (!element || typeof element.addEventListener !== "function") { + return null; + } + return element; } bindGlobalEvents() { diff --git a/js/ui/applicationBootstrap.js b/js/ui/applicationBootstrap.js new file mode 100644 index 00000000..1447170e --- /dev/null +++ b/js/ui/applicationBootstrap.js @@ -0,0 +1,955 @@ +import { devLogger } from "../utils/logger.js"; +import { MediaLoader } from "../utils/mediaLoader.js"; +import { attachHealthBadges } from "../gridHealth.js"; +import { attachUrlHealthBadges } from "../urlHealthObserver.js"; +import { createWatchHistoryRenderer } from "../historyView.js"; +import WatchHistoryController from "./watchHistoryController.js"; +import WatchHistoryTelemetry from "../services/watchHistoryTelemetry.js"; +import PlaybackService from "../services/playbackService.js"; +import AuthService from "../services/authService.js"; +import DiscussionCountService from "../services/discussionCountService.js"; +import CommentThreadService from "../services/commentThreadService.js"; +import hashtagPreferences, { + HASHTAG_PREFERENCES_EVENTS, +} from "../services/hashtagPreferencesService.js"; +import NwcSettingsService from "../services/nwcSettingsService.js"; +import nostrService from "../services/nostrService.js"; +import watchHistoryService from "../watchHistoryService.js"; +import r2Service from "../services/r2Service.js"; +import { createFeedEngine } from "../feedEngine/index.js"; +import { URL_FIRST_ENABLED } from "../constants.js"; +import { ALLOW_NSFW_CONTENT } from "../config.js"; +import { relayManager } from "../relayManager.js"; +import { userBlocks } from "../userBlocks.js"; +import { subscriptions } from "../subscriptions.js"; +import { accessControl } from "../accessControl.js"; +import moderationService from "../services/moderationService.js"; +import ProfileIdentityController from "./profileIdentityController.js"; +import VideoListViewController from "./videoListViewController.js"; +import ProfileModalController from "./profileModalController.js"; +import LoginModalController from "./loginModalController.js"; +import { VideoListView } from "./views/VideoListView.js"; +import MoreMenuController from "./moreMenuController.js"; +import AppChromeController from "./appChromeController.js"; +import { getSidebarLoadingMarkup } from "../sidebarLoading.js"; +import { isWatchHistoryDebugEnabled } from "../watchHistoryDebug.js"; +import { splitAndZap as splitAndZapDefault } from "../payments/zapSplit.js"; +import { + getDefaultModerationSettings, + getModerationSettings, + setModerationSettings, + resetModerationSettings, + persistSavedProfiles, + getSavedProfiles, + getActiveProfilePubkey, + setActiveProfilePubkey as setStoredActiveProfilePubkey, + getProfileCacheMap, + setSavedProfiles, +} from "../state/cache.js"; +import { nostrClient } from "../nostrClientFacade.js"; +import { ingestLocalViewEvent } from "../viewCounter.js"; +import { setModalState as setGlobalModalState } from "../state/appState.js"; +import { truncateMiddle, formatShortNpub } from "../utils/formatters.js"; +import { escapeHTML as escapeHtml, removeTrackingScripts } from "../utils/domUtils.js"; +import { deriveTorrentPlaybackConfig } from "../playbackUtils.js"; +import { isValidMagnetUri } from "../utils/magnetValidators.js"; +import { torrentClient } from "../webtorrent.js"; +import getAuthProvider, { + providers as authProviders, +} from "../services/authProviders/index.js"; +import { + MAX_WALLET_DEFAULT_ZAP, + ADMIN_SUPER_NPUB, + ADMIN_DM_IMAGE_URL, + BITVID_WEBSITE_URL, + isDevMode, +} from "../config.js"; +import { ADMIN_INITIAL_EVENT_BLACKLIST } from "../lists.js"; +import { + prepareStaticModal, + openStaticModal, + closeStaticModal, +} from "./components/staticModalAccessibility.js"; +import ModalManager from "./ModalManager.js"; + +export default class ApplicationBootstrap { + constructor({ + app, + services = {}, + ui = {}, + helpers = {}, + documentRef = typeof document !== "undefined" ? document : null, + windowRef = typeof window !== "undefined" ? window : null, + assets = {}, + } = {}) { + this.app = app; + this.services = services; + this.ui = ui; + this.helpers = helpers; + this.document = documentRef; + this.window = windowRef; + this.assets = assets; + + this.modalManager = null; + this.boundNwcSettingsToastHandler = null; + } + + initialize() { + const app = this.app; + const doc = this.document; + + app.loginButton = doc?.getElementById("loginButton") || null; + app.logoutButton = doc?.getElementById("logoutButton") || null; + app.userStatus = doc?.getElementById("userStatus") || null; + app.userPubKey = doc?.getElementById("userPubKey") || null; + app.uploadButton = doc?.getElementById("uploadButton") || null; + + const mediaLoaderFactory = + typeof this.helpers.mediaLoaderFactory === "function" + ? this.helpers.mediaLoaderFactory + : () => new MediaLoader(); + app.mediaLoader = + this.helpers.mediaLoader instanceof MediaLoader + ? this.helpers.mediaLoader + : mediaLoaderFactory(); + app.loadedThumbnails = new Map(); + app.urlHealthSnapshots = new Map(); + app.streamHealthSnapshots = new Map(); + app.boundStreamHealthBadgeHandler = (detail) => + app.handleStreamHealthBadgeUpdate(detail); + app.attachHealthBadgesWithCache = (container) => { + attachHealthBadges(container, { + onUpdate: app.boundStreamHealthBadgeHandler, + }); + }; + app.defaultModerationSettings = getDefaultModerationSettings(); + app.moderationSettings = { ...app.defaultModerationSettings }; + app.relayManager = relayManager; + app.activeIntervals = []; + app.watchHistoryTelemetry = null; + app.authEventUnsubscribes = []; + app.unsubscribeFromNostrService = null; + app.designSystemContext = { + getMode: () => "new", + isNew: () => true, + }; + app.videoModalReadyPromise = null; + + app.pendingModalZapOpen = false; + app.videoListViewPlaybackHandler = null; + app.videoListViewEditHandler = null; + app.videoListViewRevertHandler = null; + app.videoListViewDeleteHandler = null; + app.deleteModal = null; + app.moreMenuController = null; + app.latestFeedMetadata = null; + app.lastModalTrigger = null; + app.modalCommentState = { + videoEventId: null, + videoDefinitionAddress: null, + parentCommentId: null, + }; + app.modalCommentProfiles = new Map(); + app.modalCommentLimit = 40; + app.modalCommentLoadPromise = null; + app.modalCommentPublishPromise = null; + app.uploadSubmitPromise = null; + app.pendingModeratedPlayback = null; + app.lastIdentityRefreshPromise = null; + + app.profileIdentityController = new ProfileIdentityController({ + callbacks: { + safeEncodeNpub: (pubkey) => app.safeEncodeNpub(pubkey), + formatShortNpub: (value) => formatShortNpub(value), + }, + logger: devLogger, + }); + app.videoListViewController = new VideoListViewController({ + getSidebarLoadingMarkup, + logger: devLogger, + }); + app.appChromeController = null; + + app.nostrService = this.services.nostrService || nostrService; + app.r2Service = this.services.r2Service || r2Service; + + app.feedEngine = + this.services.feedEngine || + createFeedEngine({ + logger: (...args) => { + if (!isWatchHistoryDebugEnabled()) { + return; + } + devLogger.info(...args); + }, + }); + app.payments = this.services.payments || null; + app.splitAndZap = + (this.services.payments && this.services.payments.splitAndZap) || + splitAndZapDefault; + + app.discussionCountService = + this.services.discussionCountService || new DiscussionCountService(); + + app.nwcSettingsService = + this.services.nwcSettingsService || + new NwcSettingsService({ + normalizeHexPubkey: (value) => app.normalizeHexPubkey(value), + getActivePubkey: () => app.pubkey, + payments: app.payments, + logger: { + warn: (...args) => devLogger.warn(...args), + }, + notifyError: (message) => app.showError(message), + maxWalletDefaultZap: MAX_WALLET_DEFAULT_ZAP, + }); + app.hashtagPreferences = this.services.hashtagPreferences || hashtagPreferences; + app.hashtagPreferencesSnapshot = app.createHashtagPreferencesSnapshot(); + app.hashtagPreferencesSnapshotSignature = + app.computeHashtagPreferencesSignature(app.hashtagPreferencesSnapshot); + app.hashtagPreferencesPublishInFlight = false; + app.hashtagPreferencesPublishPromise = null; + app.boundHashtagPreferencesChangeHandler = null; + app.unsubscribeFromHashtagPreferencesChange = null; + if ( + app.hashtagPreferences && + typeof app.hashtagPreferences.on === "function" + ) { + app.boundHashtagPreferencesChangeHandler = (detail) => + app.handleHashtagPreferencesChange(detail); + try { + app.unsubscribeFromHashtagPreferencesChange = + app.hashtagPreferences.on( + HASHTAG_PREFERENCES_EVENTS.CHANGE, + app.boundHashtagPreferencesChangeHandler, + ); + } catch (error) { + devLogger.warn( + "[Application] Failed to subscribe to hashtag preferences changes:", + error, + ); + } + } + if ( + app.nwcSettingsService && + typeof app.nwcSettingsService.setActivePubkeyGetter === "function" + ) { + app.nwcSettingsService.setActivePubkeyGetter(() => app.pubkey); + } + if ( + app.nwcSettingsService && + typeof app.nwcSettingsService.setPayments === "function" + ) { + app.nwcSettingsService.setPayments(app.payments); + } + if ( + app.feedEngine && + typeof app.feedEngine.run !== "function" && + typeof app.feedEngine.runFeed === "function" + ) { + app.feedEngine.run = (...args) => app.feedEngine.runFeed(...args); + } + app.registerRecentFeed(); + app.registerSubscriptionsFeed(); + app.registerWatchHistoryFeed(); + + app.watchHistoryController = new WatchHistoryController({ + watchHistoryService, + nostrClient, + showError: (message) => app.showError(message), + showSuccess: (message) => app.showSuccess(message), + dropWatchHistoryMetadata: (pointerKey) => + app.dropWatchHistoryMetadata(pointerKey), + getActivePubkey: () => + typeof app.pubkey === "string" && app.pubkey ? app.pubkey : "", + designSystem: app.designSystemContext, + }); + + app.watchHistoryTelemetry = new WatchHistoryTelemetry({ + watchHistoryService, + watchHistoryController: app.watchHistoryController, + nostrClient, + log: (message, ...args) => app.log(message, ...args), + normalizeHexPubkey: (value) => app.normalizeHexPubkey(value), + getActiveUserPubkey: () => app.pubkey, + ingestLocalViewEvent, + }); + + const playbackDependencies = { + torrentClient: this.services.torrentClient || torrentClient, + deriveTorrentPlaybackConfig: + this.services.deriveTorrentPlaybackConfig || deriveTorrentPlaybackConfig, + isValidMagnetUri: + this.services.isValidMagnetUri || isValidMagnetUri, + }; + + app.playbackService = + this.services.playbackService || + new PlaybackService({ + logger: devLogger, + torrentClient: playbackDependencies.torrentClient, + deriveTorrentPlaybackConfig: playbackDependencies.deriveTorrentPlaybackConfig, + isValidMagnetUri: playbackDependencies.isValidMagnetUri, + urlFirstEnabled: URL_FIRST_ENABLED, + analyticsCallbacks: { + "session-start": (detail) => { + const urlProvided = detail?.urlProvided ? "true" : "false"; + const magnetProvided = detail?.magnetProvided ? "true" : "false"; + const magnetUsable = detail?.magnetUsable ? "true" : "false"; + app.log( + `[playVideoWithFallback] Session start urlProvided=${urlProvided} magnetProvided=${magnetProvided} magnetUsable=${magnetUsable}`, + ); + }, + fallback: (detail) => { + if (detail?.reason) { + app.log( + `[playVideoWithFallback] Falling back to WebTorrent (${detail.reason}).`, + ); + } + }, + error: (detail) => { + if (detail?.error) { + app.log("[playVideoWithFallback] Playback error observed", detail.error); + } + }, + }, + }); + app.activePlaybackResultPromise = null; + app.activePlaybackSession = null; + + app.authService = + this.services.authService || + new AuthService({ + nostrClient, + userBlocks, + relayManager, + logger: devLogger, + accessControl, + authProviders: this.services.authProviders || authProviders, + getAuthProvider: this.services.getAuthProvider || getAuthProvider, + }); + app.authEventUnsubscribes.push( + app.authService.on("auth:login", (detail) => { + const maybePromise = app.handleAuthLogin(detail); + if (maybePromise && typeof maybePromise.then === "function") { + maybePromise.catch((error) => { + devLogger.error("Failed to process auth login event:", error); + }); + } + }), + ); + app.authEventUnsubscribes.push( + app.authService.on("auth:logout", (detail) => { + if (detail && typeof detail === "object") { + if (detail.__handled === true) { + return; + } + try { + detail.__handled = true; + } catch (error) { + devLogger.warn( + "Failed to mark auth logout detail as handled:", + error, + ); + } + } + + const maybePromise = app.handleAuthLogout(detail); + if (maybePromise && typeof maybePromise.then === "function") { + maybePromise.catch((error) => { + devLogger.error("Failed to process auth logout event:", error); + }); + } + }), + ); + app.authEventUnsubscribes.push( + app.authService.on("profile:updated", (detail) => { + try { + app.handleProfileUpdated(detail); + } catch (error) { + devLogger.warn( + "Failed to process profile update event:", + error, + ); + } + }), + ); + + app.commentThreadService = + this.services.commentThreadService || + new CommentThreadService({ + fetchVideoComments: (target, options) => + nostrClient?.fetchVideoComments?.(target, options), + subscribeVideoComments: (target, options) => + nostrClient?.subscribeVideoComments?.(target, options), + getProfileCacheEntry: (pubkey) => app.getProfileCacheEntry(pubkey), + batchFetchProfiles: (pubkeys) => app.batchFetchProfiles(pubkeys), + logger: { + warn: (...args) => devLogger.warn(...args), + }, + }); + app.profileController = null; + app.loginModalController = null; + app.currentUserNpub = null; + + app.initializeLoginModalController({ logIfMissing: true }); + + app.profileButton = doc?.getElementById("profileButton") || null; + app.profileAvatar = doc?.getElementById("profileAvatar") || null; + + const modalManager = new ModalManager({ + app, + ui: this.ui, + documentRef: doc, + assets: { + fallbackThumbnailSrc: this.assets.fallbackThumbnailSrc, + }, + }); + modalManager.initialize(); + this.modalManager = modalManager; + + const modalContainer = doc?.getElementById("modalContainer") || null; + try { + if (modalContainer) { + const profileModalServices = { + normalizeHexPubkey: (value) => app.normalizeHexPubkey(value), + safeEncodeNpub: (pubkey) => app.safeEncodeNpub(pubkey), + safeDecodeNpub: (npub) => app.safeDecodeNpub(npub), + truncateMiddle: (value, maxLength) => truncateMiddle(value, maxLength), + formatShortNpub: (value) => formatShortNpub(value), + getProfileCacheEntry: (pubkey) => app.getProfileCacheEntry(pubkey), + batchFetchProfiles: (authorSet) => app.batchFetchProfiles(authorSet), + switchProfile: (pubkey) => app.authService.switchProfile(pubkey), + removeSavedProfile: (pubkey) => + app.authService.removeSavedProfile(pubkey), + relayManager, + userBlocks, + nostrClient, + nostrService: app.nostrService, + subscriptions, + accessControl, + moderation: moderationService, + getCurrentUserNpub: () => app.getCurrentUserNpub(), + nwcSettings: app.nwcSettingsService, + moderationSettings: { + getDefaultModerationSettings: () => getDefaultModerationSettings(), + getActiveModerationSettings: () => getModerationSettings(), + updateModerationSettings: (partial = {}) => + setModerationSettings(partial), + resetModerationSettings: () => resetModerationSettings(), + }, + loadVideos: (forceFetch, context) => + app.loadVideos(forceFetch, context), + onVideosShouldRefresh: (context) => + app.onVideosShouldRefresh(context), + describeAdminError: (code) => app.describeAdminError(code), + describeNotificationError: (code) => + app.describeNotificationError(code), + onAccessControlUpdated: () => app.onAccessControlUpdated(), + persistSavedProfiles: (options) => persistSavedProfiles(options), + watchHistoryService, + authService: app.authService, + requestAddProfileLogin: (options) => + app.requestProfileAdditionLogin(options), + describeLoginError: (error, fallbackMessage) => + app.describeLoginError(error, fallbackMessage), + hashtagPreferences: app.hashtagPreferences, + getHashtagPreferences: () => app.getHashtagPreferences(), + describeHashtagPreferencesError: (error, fallbackMessage) => + app.describeHashtagPreferencesError(error, { + fallbackMessage, + }), + log: (...args) => app.log(...args), + closeAllMoreMenus: (options) => app.closeAllMoreMenus(options), + clipboard: + typeof navigator !== "undefined" && navigator?.clipboard + ? navigator.clipboard + : null, + }; + + const profileModalState = { + getSavedProfiles: () => getSavedProfiles(), + setSavedProfiles: (profiles, options) => + setSavedProfiles(Array.isArray(profiles) ? profiles : [], options), + persistSavedProfiles: (options) => persistSavedProfiles(options), + getActivePubkey: () => getActiveProfilePubkey(), + setActivePubkey: (pubkey, options) => { + const normalized = + typeof pubkey === "string" && pubkey.trim() + ? pubkey.trim() + : null; + setStoredActiveProfilePubkey(normalized, options); + return getActiveProfilePubkey(); + }, + }; + + const profileModalCallbacks = { + onClose: () => app.handleProfileModalClosed(), + onLogout: async () => app.requestLogout(), + onChannelLink: (element) => app.handleProfileChannelLink(element), + onAddAccount: (payload) => app.handleAddProfile(payload), + onRequestLogoutProfile: (payload) => + app.handleProfileLogoutRequest(payload), + onRequestSwitchProfile: (payload) => + app.handleProfileSwitchRequest(payload), + onRelayOperation: (payload) => + app.handleProfileRelayOperation(payload), + onRelayModeToggle: (payload) => + app.handleProfileRelayModeToggle(payload), + onRelayRestore: (payload) => + app.handleProfileRelayRestore(payload), + onBlocklistMutation: (payload) => + app.handleProfileBlocklistMutation(payload), + onWalletPersist: (payload) => + app.handleProfileWalletPersist(payload), + onWalletTestRequest: (payload) => + app.handleProfileWalletTest(payload), + onWalletDisconnectRequest: (payload) => + app.handleProfileWalletDisconnect(payload), + onAdminMutation: (payload) => + app.handleProfileAdminMutation(payload), + onAdminNotifyError: (payload) => + app.handleProfileAdminNotifyError(payload), + onHistoryReady: (payload) => + app.handleProfileHistoryEvent(payload), + onModerationSettingsChange: (payload) => + app.handleModerationSettingsChange(payload), + }; + + app.profileController = new ProfileModalController({ + modalContainer, + removeTrackingScripts, + createWatchHistoryRenderer, + setGlobalModalState, + showError: (message) => app.showError(message), + showSuccess: (message) => app.showSuccess(message), + showStatus: (message) => app.showStatus(message), + constants: { + MAX_WALLET_DEFAULT_ZAP, + ADMIN_SUPER_NPUB, + ADMIN_DM_IMAGE_URL, + BITVID_WEBSITE_URL, + }, + services: profileModalServices, + state: profileModalState, + callbacks: profileModalCallbacks, + designSystem: app.designSystemContext, + }); + } else { + devLogger.warn( + "[Application] Profile modal controller disabled: modal container not found.", + ); + } + } catch (error) { + devLogger.error("Failed to initialize profile modal controller:", error); + } + + app.status = doc?.getElementById("status") || null; + app.progressBar = doc?.getElementById("progress") || null; + app.peers = doc?.getElementById("peers") || null; + app.speed = doc?.getElementById("speed") || null; + app.downloaded = doc?.getElementById("downloaded") || null; + + app.cleanupPromise = null; + + app.moreMenuController = new MoreMenuController({ + document: doc, + accessControl, + userBlocks, + subscriptions, + clipboard: + typeof navigator !== "undefined" && navigator?.clipboard + ? navigator.clipboard + : null, + isDevMode, + designSystem: app.designSystemContext, + callbacks: { + getCurrentVideo: () => app.currentVideo, + getCurrentUserNpub: () => app.getCurrentUserNpub(), + getCurrentUserPubkey: () => app.pubkey, + canCurrentUserManageBlacklist: () => + app.canCurrentUserManageBlacklist(), + openCreatorChannel: () => app.openCreatorChannel(), + goToProfile: (author) => app.goToProfile(author), + showError: (message) => app.showError(message), + showSuccess: (message) => app.showSuccess(message), + safeEncodeNpub: (pubkey) => app.safeEncodeNpub(pubkey), + safeDecodeNpub: (npub) => app.safeDecodeNpub(npub), + buildShareUrlFromEventId: (eventId) => + app.buildShareUrlFromEventId(eventId), + handleRemoveHistoryAction: (payload) => + app.handleRemoveHistoryAction(payload), + handleRepostAction: (payload) => app.handleRepostAction(payload), + handleMirrorAction: (payload) => app.handleMirrorAction(payload), + handleEnsurePresenceAction: (payload) => + app.handleEnsurePresenceAction(payload), + loadVideos: () => app.loadVideos(), + refreshAllVideoGrids: (options) => app.refreshAllVideoGrids(options), + onUserBlocksUpdated: () => { + if (app.profileController) { + try { + app.profileController.populateBlockedList(); + } catch (error) { + devLogger.warn( + "[profileModal] Failed to refresh blocked list after update:", + error, + ); + } + } + }, + }, + }); + app.moreMenuController.setVideoModal(app.videoModal); + app.videoSettingsPopovers = new Map(); + app.tagPreferencePopovers = new Map(); + + app.subscriptionsLink = null; + + app.notificationPortal = doc?.getElementById("notificationPortal") || null; + app.errorContainer = doc?.getElementById("errorContainer") || null; + app.successContainer = doc?.getElementById("successContainer") || null; + app.statusContainer = doc?.getElementById("statusContainer") || null; + app.statusMessage = + app.statusContainer?.querySelector("[data-status-message]") || null; + app.statusAutoHideHandle = null; + app.lastExperimentalWarningKey = null; + app.lastExperimentalWarningAt = 0; + + app.pubkey = null; + app.currentMagnetUri = null; + app.currentVideo = null; + app.currentVideoPointer = null; + app.currentVideoPointerKey = null; + app.videoSubscription = app.nostrService.getVideoSubscription() || null; + app.videoList = null; + app.videoListPopularTags = null; + app.modalViewCountUnsub = null; + app.modalReactionUnsub = null; + app.modalReactionPointerKey = null; + app.modalReactionState = { + counts: { "+": 0, "-": 0 }, + total: 0, + userReaction: "", + }; + + app.videosMap = app.nostrService.getVideosMap(); + app.unsubscribeFromNostrService = app.nostrService.on( + "subscription:changed", + ({ subscription }) => { + app.videoSubscription = subscription || null; + }, + ); + app.boundNwcSettingsToastHandler = null; + Object.defineProperty(app, "savedProfiles", { + configurable: false, + enumerable: false, + get() { + return getSavedProfiles(); + }, + set(next) { + setSavedProfiles(Array.isArray(next) ? next : [], { + persist: false, + persistActive: false, + }); + }, + }); + + Object.defineProperty(app, "activeProfilePubkey", { + configurable: false, + enumerable: false, + get() { + return getActiveProfilePubkey(); + }, + set(value) { + setStoredActiveProfilePubkey(value, { persist: false }); + }, + }); + + Object.defineProperty(app, "profileCache", { + configurable: false, + enumerable: false, + get() { + return getProfileCacheMap(); + }, + }); + + if ( + this.window && + typeof this.window.addEventListener === "function" + ) { + this.boundNwcSettingsToastHandler = (event) => { + const detail = event?.detail || {}; + if (detail.source !== "nwc-settings") { + return; + } + const rawMessage = + typeof detail.message === "string" ? detail.message.trim() : ""; + const message = rawMessage || "Wallet settings storage issue detected."; + app.log(`[nwcSettings] ${message}`); + if (detail.variant === "warning") { + app.showStatus(message); + if (this.window && typeof this.window.setTimeout === "function") { + this.window.setTimeout(() => { + app.showStatus(""); + }, 5000); + } + } else { + app.showError(message); + } + }; + this.window.addEventListener("bitvid:toast", this.boundNwcSettingsToastHandler); + } + + const magnetValidator = playbackDependencies.isValidMagnetUri; + + const videoListViewConfig = { + document: doc, + mediaLoader: app.mediaLoader, + badgeHelpers: { + attachHealthBadges: app.attachHealthBadgesWithCache, + attachUrlHealthBadges: (container, onCheck) => + attachUrlHealthBadges(container, onCheck), + }, + formatters: { + formatTimeAgo: (timestamp) => app.formatTimeAgo(timestamp), + formatViewCountLabel: (total) => app.formatViewCountLabel(total), + }, + helpers: { + escapeHtml: (value) => app.escapeHTML(value), + isMagnetSupported: (magnet) => magnetValidator(magnet), + toLocaleString: (value) => + typeof value === "number" ? value.toLocaleString() : value, + }, + assets: { + fallbackThumbnailSrc: this.assets.fallbackThumbnailSrc, + unsupportedBtihMessage: this.assets.unsupportedBtihMessage, + }, + state: { + loadedThumbnails: app.loadedThumbnails, + videosMap: app.videosMap, + urlHealthByVideoId: app.urlHealthSnapshots, + streamHealthByVideoId: app.streamHealthSnapshots, + }, + utils: { + dedupeVideos: (videos) => app.dedupeVideosByRoot(videos), + getAllEvents: () => Array.from(nostrClient.allEvents.values()), + hasOlderVersion: (video, events) => app.hasOlderVersion(video, events), + derivePointerInfo: (video) => app.deriveVideoPointerInfo(video), + persistWatchHistoryMetadata: (video, pointerInfo) => + app.persistWatchHistoryMetadataForVideo(video, pointerInfo), + getShareUrlBase: () => app.getShareUrlBase(), + buildShareUrlFromNevent: (nevent) => app.buildShareUrlFromNevent(nevent), + buildShareUrlFromEventId: (eventId) => app.buildShareUrlFromEventId(eventId), + getKnownVideoPostedAt: (video) => app.getKnownVideoPostedAt(video), + resolveVideoPostedAt: (video) => app.resolveVideoPostedAt(video), + canManageBlacklist: () => app.canCurrentUserManageBlacklist(), + canEditVideo: (video) => video?.pubkey === app.pubkey, + canDeleteVideo: (video) => video?.pubkey === app.pubkey, + batchFetchProfiles: (authorSet) => app.batchFetchProfiles(authorSet), + bindThumbnailFallbacks: (container) => app.bindThumbnailFallbacks(container), + handleUrlHealthBadge: (payload) => app.handleUrlHealthBadge(payload), + refreshDiscussionCounts: (videos, { container } = {}) => + app.refreshVideoDiscussionCounts(videos, { + videoListRoot: container || app.videoList || null, + }), + ensureGlobalMoreMenuHandlers: () => app.ensureGlobalMoreMenuHandlers(), + requestMoreMenu: (detail = {}) => app.requestMoreMenu(detail), + closeMoreMenu: (detail = {}) => app.closeMoreMenu(detail), + requestSettingsMenu: (detail = {}) => + app.requestVideoSettingsMenu(detail), + closeSettingsMenu: (detail = {}) => + app.closeVideoSettingsMenu(detail), + closeAllMenus: (options) => app.closeAllMoreMenus(options), + }, + renderers: { + getLoadingMarkup: (message) => getSidebarLoadingMarkup(message), + }, + allowNsfw: ALLOW_NSFW_CONTENT === true, + designSystem: app.designSystemContext, + }; + app.videoListView = + (typeof this.ui.videoListView === "function" + ? this.ui.videoListView({ app, config: videoListViewConfig }) + : this.ui.videoListView) || + new VideoListView(videoListViewConfig); + + if ( + app.videoListView && + typeof app.videoListView.setTagPreferenceStateResolver === "function" + ) { + app.videoListView.setTagPreferenceStateResolver((tag) => + app.getTagPreferenceState(tag), + ); + } + + if ( + app.videoListView && + typeof app.videoListView.setTagActivationHandler === "function" + ) { + app.videoListView.setTagActivationHandler((detail = {}) => + app.handleTagPreferenceActivation(detail), + ); + } + + app.videoListViewPlaybackHandler = ({ + videoId, + url, + magnet, + trigger, + }) => { + if (videoId) { + Promise.resolve( + app.playVideoByEventId(videoId, { url, magnet, trigger }), + ).catch((error) => { + devLogger.error("[VideoListView] Failed to play by event id:", error); + }); + return; + } + Promise.resolve( + app.playVideoWithFallback({ url, magnet, trigger }), + ).catch((error) => { + devLogger.error("[VideoListView] Failed to start playback:", error); + }); + }; + app.videoListView.setPlaybackHandler(app.videoListViewPlaybackHandler); + + app.videoListViewEditHandler = ({ video, index, trigger }) => { + if (!video?.id) { + return; + } + app.handleEditVideo({ + eventId: video.id, + index: Number.isFinite(index) ? index : null, + triggerElement: trigger, + video, + }); + }; + app.videoListView.setEditHandler(app.videoListViewEditHandler); + + app.videoListViewRevertHandler = ({ video, index, trigger }) => { + if (!video?.id) { + return; + } + app.handleRevertVideo({ + eventId: video.id, + index: Number.isFinite(index) ? index : null, + triggerElement: trigger, + video, + }); + }; + app.videoListView.setRevertHandler(app.videoListViewRevertHandler); + + app.videoListViewDeleteHandler = ({ video, index }) => { + if (!video?.id) { + return; + } + app.handleFullDeleteVideo({ + eventId: video.id, + index: Number.isFinite(index) ? index : null, + video, + }); + }; + app.videoListView.setDeleteHandler(app.videoListViewDeleteHandler); + + app.videoListView.setModerationOverrideHandler((detail = {}) => + app.handleModerationOverride(detail), + ); + app.videoListView.setModerationBlockHandler((detail = {}) => + app.handleModerationBlock(detail), + ); + app.videoListView.setModerationHideHandler((detail = {}) => + app.handleModerationHide(detail), + ); + + if (app.moreMenuController) { + app.moreMenuController.attachVideoListView(app.videoListView); + } + + app.closeLoginModalBtn = doc?.getElementById("closeLoginModal") || null; + + app.appChromeController = new AppChromeController({ + elements: { + logoutButton: app.logoutButton, + profileButton: app.profileButton, + uploadButton: app.uploadButton, + loginButton: app.loginButton, + closeLoginModalButton: app.closeLoginModalBtn, + }, + callbacks: { + requestLogout: () => app.requestLogout(), + showError: (message) => app.showError(message), + showProfileModal: () => + app.profileController && + typeof app.profileController.show === "function" + ? app.profileController.show() + : null, + openUploadModal: ({ triggerElement }) => { + if (app.uploadModal) { + app.uploadModal.open({ triggerElement }); + } + }, + onLoginModalOpened: () => setGlobalModalState("login", true), + onLoginModalClosed: () => setGlobalModalState("login", false), + flushWatchHistory: (reason, context) => + app.flushWatchHistory(reason, context), + cleanup: () => app.cleanup(), + hideModal: () => app.hideModal(), + }, + utilities: { + prepareLoginModal: () => + prepareStaticModal({ id: "loginModal" }) || + doc?.getElementById("loginModal"), + prepareApplicationModal: () => + prepareStaticModal({ id: "nostrFormModal" }) || + doc?.getElementById("nostrFormModal"), + openModal: (modal, options) => openStaticModal(modal, options), + closeModal: (modalId) => closeStaticModal(modalId), + }, + environment: { + document: doc, + window: this.window, + }, + logger: devLogger, + }); + + app.blacklistedEventIds = new Set(); + if (this.window?.NostrTools?.nip19?.decode) { + for (const neventStr of ADMIN_INITIAL_EVENT_BLACKLIST) { + if (!neventStr || neventStr.trim().length < 8) { + continue; + } + try { + const decoded = this.window.NostrTools.nip19.decode(neventStr); + if (decoded?.type === "nevent" && decoded.data?.id) { + app.blacklistedEventIds.add(decoded.data.id); + } + } catch (err) { + devLogger.error( + "[Application] Invalid nevent in blacklist:", + neventStr, + err, + ); + } + } + } + + app.unsubscribeFromPubkeyState = null; + app.unsubscribeFromCurrentUserState = null; + + return { modalManager }; + } + + teardown() { + if ( + this.window && + this.boundNwcSettingsToastHandler && + typeof this.window.removeEventListener === "function" + ) { + this.window.removeEventListener( + "bitvid:toast", + this.boundNwcSettingsToastHandler, + ); + } + this.boundNwcSettingsToastHandler = null; + } +} diff --git a/js/ui/components/EditModal.js b/js/ui/components/EditModal.js index a6c336d0..92d1c70d 100644 --- a/js/ui/components/EditModal.js +++ b/js/ui/components/EditModal.js @@ -891,11 +891,29 @@ export class EditModal { const finalTitle = titleWasEdited ? newTitle : original.title || ""; const finalUrl = urlWasEdited ? newUrl : original.url || ""; - const shouldUseOriginalWs = wsInput ? wsInput.readOnly !== false : true; - const shouldUseOriginalXs = xsInput ? xsInput.readOnly !== false : true; - let finalWs = shouldUseOriginalWs ? original.ws || "" : newWs; - let finalXs = shouldUseOriginalXs ? original.xs || "" : newXs; - let finalMagnet = magnetWasEdited ? newMagnet : original.magnet || ""; + const originalMagnetValue = + typeof original.magnet === "string" ? original.magnet.trim() : ""; + const originalWsValue = + typeof original.ws === "string" ? original.ws.trim() : ""; + const originalXsValue = + typeof original.xs === "string" ? original.xs.trim() : ""; + + const wsWasManuallyEdited = wsInput ? wsInput.readOnly === false : false; + const xsWasManuallyEdited = xsInput ? xsInput.readOnly === false : false; + + let finalMagnet = magnetWasEdited ? newMagnet : originalMagnetValue; + let finalWs = wsWasManuallyEdited ? newWs : originalWsValue; + let finalXs = xsWasManuallyEdited ? newXs : originalXsValue; + + if (magnetWasEdited) { + const magnetHintCandidates = extractMagnetHints(finalMagnet); + if (!wsWasManuallyEdited) { + finalWs = magnetHintCandidates.ws || ""; + } + if (!xsWasManuallyEdited) { + finalXs = magnetHintCandidates.xs || ""; + } + } const finalThumbnail = isEditing(thumbnailInput) ? newThumbnail : original.thumbnail || ""; @@ -990,6 +1008,10 @@ export class EditModal { finalXs = ""; } + const magnetChanged = magnetWasEdited && finalMagnet !== originalMagnetValue; + const wsEditedFlag = wsWasManuallyEdited || magnetChanged; + const xsEditedFlag = xsWasManuallyEdited || magnetChanged; + const updatedData = { version: original.version || 2, title: finalTitle, @@ -1000,8 +1022,8 @@ export class EditModal { mode: this.resolveModeForSubmit(), ws: finalWs, xs: finalXs, - wsEdited: !shouldUseOriginalWs, - xsEdited: !shouldUseOriginalXs, + wsEdited: wsEditedFlag, + xsEdited: xsEditedFlag, urlEdited: urlWasEdited, magnetEdited: magnetWasEdited, enableComments: finalEnableComments, diff --git a/js/ui/components/SimilarContentCard.js b/js/ui/components/SimilarContentCard.js index 904d761a..8cdb6be8 100644 --- a/js/ui/components/SimilarContentCard.js +++ b/js/ui/components/SimilarContentCard.js @@ -1,5 +1,6 @@ import { normalizeDesignSystemContext } from "../../designSystem.js"; import { formatShortNpub } from "../../utils/formatters.js"; +import { sanitizeProfileMediaUrl } from "../../utils/profileMedia.js"; const DEFAULT_PROFILE_AVATAR = "assets/svg/default-profile.svg"; @@ -213,15 +214,26 @@ export class SimilarContentCard { continue; } const trimmed = entry.trim(); - if (trimmed) { - return trimmed; + if (!trimmed) { + continue; + } + const sanitized = sanitizeProfileMediaUrl(trimmed); + if (sanitized) { + return sanitized; } } - return ""; + const fallback = + typeof baseline.picture === "string" && baseline.picture.trim() + ? sanitizeProfileMediaUrl(baseline.picture) || baseline.picture.trim() + : ""; + + return fallback; })(); - return { name, npub, shortNpub, pubkey, picture }; + const resolvedPicture = picture || DEFAULT_PROFILE_AVATAR; + + return { name, npub, shortNpub, pubkey, picture: resolvedPicture }; } applyIdentityToElements() { diff --git a/js/ui/components/VideoCard.js b/js/ui/components/VideoCard.js index 6c51c50a..efd19df1 100644 --- a/js/ui/components/VideoCard.js +++ b/js/ui/components/VideoCard.js @@ -1,5 +1,6 @@ import { normalizeDesignSystemContext } from "../../designSystem.js"; import { updateVideoCardSourceVisibility } from "../../utils/cardSourceVisibility.js"; +import { sanitizeProfileMediaUrl } from "../../utils/profileMedia.js"; import { userLogger } from "../../utils/logger.js"; import { applyModerationContextDatasets, @@ -9,6 +10,8 @@ import { import { buildModerationBadgeText } from "../moderationCopy.js"; const SVG_NAMESPACE = "http://www.w3.org/2000/svg"; +const DEFAULT_PROFILE_AVATAR = "assets/svg/default-profile.svg"; +const HEX64_REGEX = /^[0-9a-f]{64}$/i; export class VideoCard { constructor({ @@ -27,6 +30,7 @@ export class VideoCard { assets = {}, state = {}, variant = "default", + identity = null, ensureGlobalMoreMenuHandlers, onRequestCloseAllMenus, nsfwContext = null, @@ -91,6 +95,7 @@ export class VideoCard { : null; this.designSystem = normalizeDesignSystemContext(designSystem); + this.identity = this.normalizeIdentity(identity); const normalizedVariant = typeof variant === "string" && variant.trim().toLowerCase() === "compact" @@ -461,6 +466,8 @@ export class VideoCard { header.appendChild(controls); } + this.applyIdentityToAuthorElements(); + content.appendChild(title); content.appendChild(header); @@ -501,6 +508,135 @@ export class VideoCard { this.refreshModerationUi(); } + normalizeIdentity(nextIdentity = {}, fallback = null) { + const baseline = fallback && typeof fallback === "object" ? fallback : {}; + const candidate = + nextIdentity && typeof nextIdentity === "object" ? nextIdentity : {}; + const video = this.video && typeof this.video === "object" ? this.video : {}; + + const pickFirstString = ( + entries = [], + { allowHex = true, sanitizer = (value) => value } = {}, + ) => { + for (const entry of entries) { + if (typeof entry !== "string") { + continue; + } + const trimmed = entry.trim(); + if (!trimmed) { + continue; + } + if (!allowHex && HEX64_REGEX.test(trimmed)) { + continue; + } + const sanitized = sanitizer(trimmed); + if (!sanitized) { + continue; + } + return sanitized; + } + return ""; + }; + + const pubkey = pickFirstString([ + candidate.pubkey, + baseline.pubkey, + video.pubkey, + video.author?.pubkey, + video.creator?.pubkey, + video.profile?.pubkey, + ]); + + const npub = pickFirstString([ + candidate.npub, + baseline.npub, + video.npub, + video.authorNpub, + video.profile?.npub, + ]); + + const shortNpub = pickFirstString([ + candidate.shortNpub, + baseline.shortNpub, + video.shortNpub, + video.creatorNpub, + ]); + + const name = pickFirstString( + [ + candidate.name, + candidate.display_name, + candidate.displayName, + candidate.username, + baseline.name, + baseline.display_name, + baseline.displayName, + baseline.username, + video.creatorName, + video.authorName, + video.creator?.name, + video.author?.name, + video.profile?.display_name, + video.profile?.name, + video.profile?.username, + ], + { allowHex: false }, + ); + + const picture = pickFirstString( + [ + candidate.picture, + candidate.image, + candidate.photo, + baseline.picture, + baseline.image, + baseline.photo, + video.creatorPicture, + video.authorPicture, + video.creator?.picture, + video.author?.picture, + video.profile?.picture, + video.profile?.image, + video.profile?.photo, + ], + { sanitizer: (value) => sanitizeProfileMediaUrl(value) }, + ); + + const resolvedName = name || shortNpub || npub || pubkey || ""; + const resolvedPicture = picture || DEFAULT_PROFILE_AVATAR; + + return { + name: resolvedName, + npub, + shortNpub, + pubkey, + picture: resolvedPicture, + }; + } + + updateIdentity(nextIdentity = {}) { + this.identity = this.normalizeIdentity(nextIdentity, this.identity); + this.applyIdentityToAuthorElements(); + } + + applyIdentityToAuthorElements() { + const nameLabel = this.identity?.name || "Unknown"; + if (this.authorNameEl) { + this.authorNameEl.textContent = nameLabel || "Unknown"; + } + + if (this.authorPicEl) { + const picture = this.identity?.picture || DEFAULT_PROFILE_AVATAR; + if (this.authorPicEl.getAttribute("src") !== picture) { + this.authorPicEl.src = picture; + } + + const altFallback = + nameLabel || this.identity?.shortNpub || this.identity?.npub || "Channel"; + this.authorPicEl.alt = `${altFallback}'s avatar`; + } + } + setCardBackdropImage(src) { if (!this.root || !this.root.style) { return; diff --git a/js/ui/components/VideoModal.js b/js/ui/components/VideoModal.js index b0f702ea..f9675296 100644 --- a/js/ui/components/VideoModal.js +++ b/js/ui/components/VideoModal.js @@ -16,6 +16,7 @@ import { import { renderTagPillStrip, applyTagPreferenceState, + trimTagPillStripToFit, } from "./tagPillList.js"; import { SimilarContentCard } from "./SimilarContentCard.js"; import { @@ -129,6 +130,10 @@ export class VideoModal { this.videoViewCountEl = null; this.videoTagsRoot = null; this.videoTagsData = Object.freeze([]); + this.videoTagsSourceData = this.videoTagsData; + this.videoTagsResizeObserver = null; + this.videoTagsLastObservedWidth = 0; + this.handleVideoTagsResize = this.handleVideoTagsResize.bind(this); this.creatorAvatar = null; this.creatorName = null; this.creatorNpub = null; @@ -390,6 +395,7 @@ export class VideoModal { } else { this.loaded = false; this.cleanupVideoTags(); + this.teardownVideoTagsResizeObserver(); this.videoTagsRoot = null; this.playerModal = null; } @@ -509,6 +515,7 @@ export class VideoModal { if (this.videoTagsRoot && this.videoTagsRoot !== nextVideoTagsRoot) { this.cleanupVideoTags(this.videoTagsRoot); } + this.teardownVideoTagsResizeObserver(); this.videoTagsRoot = nextVideoTagsRoot; if (this.videoTagsRoot) { this.cleanupVideoTags(this.videoTagsRoot); @@ -540,10 +547,11 @@ export class VideoModal { statsContainer: statsContainerCandidate, }); - const previousTags = Array.isArray(this.videoTagsData) - ? [...this.videoTagsData] + const previousTags = Array.isArray(this.videoTagsSourceData) + ? [...this.videoTagsSourceData] : []; this.videoTagsData = null; + this.videoTagsSourceData = Object.freeze([]); this.moderationController.initialize({ playerModal }); @@ -1807,7 +1815,12 @@ export class VideoModal { } if (typeof value === "string") { const trimmed = value.trim(); - if (!trimmed || trimmed === "null" || trimmed === "undefined") { + if ( + !trimmed || + trimmed === "null" || + trimmed === "undefined" || + trimmed === "__root__" + ) { return null; } return trimmed; @@ -1930,6 +1943,7 @@ export class VideoModal { destroy() { this.close(); + this.teardownVideoTagsResizeObserver(); this.commentsController.destroy(); this.reactionsController.destroy(); this.similarContentController.destroy(); @@ -2585,6 +2599,19 @@ export class VideoModal { return; } + // Ensure title element reference is available + if (!this.videoTitle) { + this.videoTitle = this.playerModal.querySelector("#videoTitle") || null; + } + // Set title immediately when opening if video has a title + if (this.videoTitle && video && typeof video.title === "string" && video.title.trim()) { + this.videoTitle.textContent = video.title.trim(); + this.videoTitle.hidden = false; + } else if (this.videoTitle) { + this.videoTitle.textContent = "Untitled"; + this.videoTitle.hidden = false; + } + this.resetReactions(); this.playerModal.classList.remove("hidden"); @@ -2795,21 +2822,29 @@ export class VideoModal { return true; } - renderVideoTags(tags = []) { + renderVideoTags(tags = [], options = {}) { + const { force = false } = options || {}; const normalized = this.normalizeVideoTags(tags); - const hasTags = normalized.length > 0; const root = this.videoTagsRoot; if (root) { - if (this.areVideoTagsEqual(normalized, this.videoTagsData)) { - this.toggleVideoTagsVisibility(hasTags); - this.refreshTagPreferenceStates(); + if (!force && this.areVideoTagsEqual(normalized, this.videoTagsData)) { + const hasVisibleButtons = + root.querySelector("button[data-tag]") !== null; + this.toggleVideoTagsVisibility(hasVisibleButtons); + if (hasVisibleButtons) { + this.ensureVideoTagsResizeObserver(); + this.refreshTagPreferenceStates(); + } else { + this.teardownVideoTagsResizeObserver(); + } return; } this.cleanupVideoTags(root); - if (hasTags) { + let hasVisibleButtons = false; + if (normalized.length > 0) { const { root: strip } = renderTagPillStrip({ document: root.ownerDocument || this.document, tags: normalized, @@ -2819,13 +2854,119 @@ export class VideoModal { if (strip) { root.appendChild(strip); + trimTagPillStripToFit({ strip, container: root }); + + if (strip.querySelector("button[data-tag]")) { + hasVisibleButtons = true; + } else if (strip.parentNode === root) { + root.removeChild(strip); + } } } - this.toggleVideoTagsVisibility(hasTags); + this.toggleVideoTagsVisibility(hasVisibleButtons); + if (hasVisibleButtons) { + this.ensureVideoTagsResizeObserver(); + this.refreshTagPreferenceStates(); + } else { + this.teardownVideoTagsResizeObserver(); + } + } else { + this.teardownVideoTagsResizeObserver(); } - this.videoTagsData = Object.freeze([...normalized]); + const stored = Object.freeze([...normalized]); + this.videoTagsData = stored; + this.videoTagsSourceData = stored; + } + + reflowVideoTags() { + if (!Array.isArray(this.videoTagsSourceData)) { + return; + } + + if (this.videoTagsSourceData.length === 0) { + return; + } + + this.renderVideoTags([...this.videoTagsSourceData], { force: true }); + } + + ensureVideoTagsResizeObserver() { + const root = this.videoTagsRoot; + if (!root) { + return; + } + + const ResizeObserverCtor = + (this.window && this.window.ResizeObserver) || + globalThis.ResizeObserver || + null; + if (typeof ResizeObserverCtor !== "function") { + return; + } + + if (!this.videoTagsResizeObserver) { + this.videoTagsResizeObserver = new ResizeObserverCtor( + this.handleVideoTagsResize, + ); + } else if (typeof this.videoTagsResizeObserver.disconnect === "function") { + this.videoTagsResizeObserver.disconnect(); + } + + try { + this.videoTagsResizeObserver.observe(root); + } catch (error) { + // Ignore observer errors (e.g., observing a detached node). + } + } + + teardownVideoTagsResizeObserver() { + if (this.videoTagsResizeObserver) { + try { + this.videoTagsResizeObserver.disconnect(); + } catch (error) { + // Ignore teardown errors. + } + } + this.videoTagsResizeObserver = null; + this.videoTagsLastObservedWidth = 0; + } + + handleVideoTagsResize(entries = []) { + if (!this.videoTagsRoot) { + return; + } + + const entry = + Array.isArray(entries) && entries.length > 0 + ? entries.find((item) => item?.target === this.videoTagsRoot) || + entries[0] + : null; + + const measuredWidthRaw = entry + ? entry.contentRect && typeof entry.contentRect.width === "number" + ? entry.contentRect.width + : typeof entry.contentBoxSize?.[0]?.inlineSize === "number" + ? entry.contentBoxSize[0].inlineSize + : this.videoTagsRoot.clientWidth || 0 + : this.videoTagsRoot.clientWidth || 0; + + const measuredWidth = Number.isFinite(measuredWidthRaw) + ? Math.max(0, Math.round(measuredWidthRaw)) + : 0; + + if (measuredWidth <= 0) { + this.videoTagsLastObservedWidth = 0; + return; + } + + if (this.videoTagsLastObservedWidth === measuredWidth) { + return; + } + + this.videoTagsLastObservedWidth = measuredWidth; + this.reflowVideoTags(); } handleVideoTagActivate(tag, { event, button } = {}) { @@ -3506,7 +3647,43 @@ export class VideoModal { return; } - receipts.forEach((receipt) => { + const normalized = receipts.filter( + (receipt) => receipt && typeof receipt === "object" + ); + + const validatedReceipts = normalized.filter( + (receipt) => receipt?.validation?.status === "passed" && receipt.validation.event + ); + + const paymentFailures = normalized.filter((receipt) => { + if (!receipt) { + return false; + } + const status = + typeof receipt.status === "string" ? receipt.status.toLowerCase() : ""; + return status && status !== "success"; + }); + + const unvalidatedReceipts = normalized.filter((receipt) => { + if (!receipt) { + return false; + } + const status = + typeof receipt.status === "string" ? receipt.status.toLowerCase() : "success"; + if (status !== "success" && status !== "") { + return false; + } + const validationStatus = + typeof receipt.validation?.status === "string" + ? receipt.validation.status.toLowerCase() + : ""; + if (!validationStatus || validationStatus === "skipped") { + return false; + } + return validationStatus !== "passed"; + }); + + const renderReceiptItem = ({ receipt, tone }) => { const li = this.document.createElement("li"); li.className = "rounded border border-border p-3 bg-overlay-panel-soft"; @@ -3528,11 +3705,16 @@ export class VideoModal { )} sats`; const status = this.document.createElement("span"); - const isSuccess = receipt.status - ? receipt.status === "success" - : !receipt.error; - status.textContent = isSuccess ? "Success" : "Failed"; - status.className = isSuccess ? "text-info" : "text-critical"; + if (tone === "validated") { + status.textContent = "Validated"; + status.className = "text-info"; + } else if (tone === "failed") { + status.textContent = "Failed"; + status.className = "text-critical"; + } else { + status.textContent = "Pending"; + status.className = "text-muted"; + } header.appendChild(shareLabel); header.appendChild(status); @@ -3547,7 +3729,14 @@ export class VideoModal { const detail = this.document.createElement("p"); detail.className = "mt-2 text-xs text-muted"; - if (isSuccess) { + if (tone === "failed") { + const errorMessage = + (receipt.error && receipt.error.message) || + (typeof receipt.error === "string" + ? receipt.error + : "Payment failed."); + detail.textContent = errorMessage; + } else { let detailMessage = "Invoice settled."; const preimage = receipt.payment?.result?.preimage; if (typeof preimage === "string" && preimage) { @@ -3556,18 +3745,59 @@ export class VideoModal { }`; } detail.textContent = detailMessage; - } else { - const errorMessage = - (receipt.error && receipt.error.message) || - (typeof receipt.error === "string" - ? receipt.error - : "Payment failed."); - detail.textContent = errorMessage; } li.appendChild(detail); this.modalZapReceipts.appendChild(li); + }; + + validatedReceipts.forEach((receipt) => { + renderReceiptItem({ receipt, tone: "validated" }); }); + + paymentFailures.forEach((receipt) => { + renderReceiptItem({ receipt, tone: "failed" }); + }); + + if (!validatedReceipts.length && !paymentFailures.length && !unvalidatedReceipts.length) { + const empty = this.document.createElement("li"); + empty.className = "text-sm text-text"; + empty.textContent = partial + ? "No zap receipts available." + : "No zap receipts published yet."; + this.modalZapReceipts.appendChild(empty); + return; + } + + if (unvalidatedReceipts.length) { + const warning = this.document.createElement("li"); + warning.className = + "rounded border border-border p-3 bg-overlay-panel-soft text-xs text-warning-strong"; + const summaries = unvalidatedReceipts.map((receipt) => { + const shareType = receipt.recipientType || receipt.type || "creator"; + const label = + shareType === "platform" + ? "Platform" + : shareType === "creator" + ? "Creator" + : "Lightning"; + const address = + typeof receipt.address === "string" && receipt.address + ? ` (${receipt.address})` + : ""; + const reason = + typeof receipt.validation?.reason === "string" && receipt.validation.reason + ? ` — ${receipt.validation.reason}` + : " — Awaiting compliant receipt."; + return `${label}${address}${reason}`; + }); + + const intro = validatedReceipts.length + ? "Awaiting validated zap receipt for remaining share(s)." + : "No validated zap receipts yet."; + warning.textContent = `${intro} ${summaries.join(" ")}`.trim(); + this.modalZapReceipts.appendChild(warning); + } } setZapPending(pending) { @@ -3715,8 +3945,35 @@ export class VideoModal { creator, tags, } = {}) { - if (this.videoTitle && title !== undefined) { - this.videoTitle.textContent = title || "Untitled"; + if (title !== undefined) { + // Try to find the title element if not already cached + if (!this.videoTitle) { + if (this.playerModal) { + this.videoTitle = this.playerModal.querySelector("#videoTitle") || null; + } + // Fallback: try document query if playerModal query failed + if (!this.videoTitle) { + this.videoTitle = this.document.getElementById("videoTitle") || null; + } + } + if (this.videoTitle) { + const titleText = + typeof title === "string" && title.trim() + ? title.trim() + : "Untitled"; + this.videoTitle.textContent = titleText; + // Ensure element is visible + this.videoTitle.hidden = false; + if (this.videoTitle.style) { + this.videoTitle.style.display = ""; + } + } else { + // Log for debugging if element cannot be found + this.logger?.log?.( + "[VideoModal] Could not find #videoTitle element to set title:", + title + ); + } } if (this.videoDescription && description !== undefined) { this.renderVideoDescription(description); @@ -5063,12 +5320,30 @@ export class VideoModal { continue; } const trimmed = candidate.trim(); - if (trimmed) { - picture = trimmed; + if (!trimmed) { + continue; + } + const sanitized = sanitizeProfileMediaUrl(trimmed); + if (sanitized) { + picture = sanitized; break; } } + if (!picture && pubkey) { + const robohash = `https://robohash.org/${pubkey}`; + picture = sanitizeProfileMediaUrl(robohash) || robohash; + } + + if (!picture) { + const fallbackAvatar = + typeof this.DEFAULT_PROFILE_AVATAR === "string" && + this.DEFAULT_PROFILE_AVATAR.trim() + ? this.DEFAULT_PROFILE_AVATAR.trim() + : "assets/svg/default-profile.svg"; + picture = sanitizeProfileMediaUrl(fallbackAvatar) || fallbackAvatar; + } + return { name, npub, diff --git a/js/ui/components/nip71FormManager.js b/js/ui/components/nip71FormManager.js index 2d1428e6..6c7dc589 100644 --- a/js/ui/components/nip71FormManager.js +++ b/js/ui/components/nip71FormManager.js @@ -199,6 +199,8 @@ export class Nip71FormManager { this.setFieldValue(entry, "dim", value.dim); this.setFieldValue(entry, "url", value.url); this.setFieldValue(entry, "x", value.x); + this.setFieldValue(entry, "duration", value.duration); + this.setFieldValue(entry, "bitrate", value.bitrate); this.hydrateNested(entry, "image", value.image); this.hydrateNested(entry, "fallback", value.fallback); this.hydrateNested(entry, "service", value.service); @@ -302,6 +304,26 @@ export class Nip71FormManager { service: this.collectNestedValues(entry, "service"), }; + const durationValue = this.getFieldValue(entry, "duration"); + if (durationValue !== "") { + const parsed = this.normalizeNumber(durationValue); + if (parsed != null && parsed >= 0) { + variant.duration = parsed; + } else { + variant.duration = durationValue; + } + } + + const bitrateValue = this.getFieldValue(entry, "bitrate"); + if (bitrateValue !== "") { + const parsed = this.normalizeNumber(bitrateValue); + if (parsed != null && parsed >= 0) { + variant.bitrate = parsed; + } else { + variant.bitrate = bitrateValue; + } + } + const hasContent = variant.m || variant.dim || @@ -309,7 +331,9 @@ export class Nip71FormManager { variant.x || variant.image.length > 0 || variant.fallback.length > 0 || - variant.service.length > 0; + variant.service.length > 0 || + variant.duration !== undefined || + variant.bitrate !== undefined; return hasContent ? variant : null; }); diff --git a/js/ui/components/tagPillList.js b/js/ui/components/tagPillList.js index 9b644fbc..dc194561 100644 --- a/js/ui/components/tagPillList.js +++ b/js/ui/components/tagPillList.js @@ -115,17 +115,99 @@ function createTagButton({ doc, tag, onTagActivate, getTagState }) { return button; } +function cleanupButtonHandler(button) { + if (!button || typeof button !== "object" || button.nodeType !== 1) { + return; + } + + const handler = button.__tagPillClickHandler; + if (handler) { + button.removeEventListener("click", handler); + delete button.__tagPillClickHandler; + } +} + +function removeTagButton(button) { + if (!button || typeof button !== "object" || button.nodeType !== 1) { + return; + } + + cleanupButtonHandler(button); + + if (typeof button.remove === "function") { + button.remove(); + } else if (button.parentNode) { + button.parentNode.removeChild(button); + } +} + function cleanupExistingButtons(root) { for (const button of root.querySelectorAll("button")) { - const handler = button.__tagPillClickHandler; - if (handler) { - button.removeEventListener("click", handler); - delete button.__tagPillClickHandler; - } + cleanupButtonHandler(button); } root.textContent = ""; } +function getAvailableContainerWidth(container) { + if (!container || container.nodeType !== 1) { + return 0; + } + + const clientWidth = Number(container.clientWidth || 0); + if (Number.isFinite(clientWidth) && clientWidth > 0) { + return clientWidth; + } + + if (typeof container.getBoundingClientRect === "function") { + try { + const rect = container.getBoundingClientRect(); + if (rect && typeof rect.width === "number" && rect.width > 0) { + return rect.width; + } + } catch (error) { + // Ignore measurement errors and fall through to return 0. + } + } + + return 0; +} + +export function trimTagPillStripToFit({ strip, container } = {}) { + if (!strip || typeof strip !== "object" || strip.nodeType !== 1) { + return { removedButtons: [] }; + } + + const host = + container && typeof container === "object" && container.nodeType === 1 + ? container + : strip.parentElement; + + const availableWidth = Math.max(0, getAvailableContainerWidth(host)); + const removedButtons = []; + + const buttons = Array.from(strip.querySelectorAll("button")); + if (!buttons.length) { + return { removedButtons }; + } + + if (availableWidth <= 0) { + return { removedButtons }; + } + + let currentButtons = buttons.length; + while (currentButtons > 0 && strip.scrollWidth > availableWidth) { + const button = buttons[currentButtons - 1]; + if (!button) { + break; + } + removeTagButton(button); + removedButtons.push(button); + currentButtons -= 1; + } + + return { removedButtons }; +} + export function renderTagPillStrip({ document: doc, tags = [], diff --git a/js/ui/components/videoMenuRenderers.js b/js/ui/components/videoMenuRenderers.js index 093be888..3e1f6dbc 100644 --- a/js/ui/components/videoMenuRenderers.js +++ b/js/ui/components/videoMenuRenderers.js @@ -288,7 +288,11 @@ export function createVideoMoreMenuPanel({ appendMenuAction(doc, list, { text: "Report", action: "report", - dataset: { eventId: metadata.id }, + dataset: { + eventId: metadata.id, + author: metadata.pubkey, + pointerRelay: pointer && pointer.relay ? pointer.relay : "", + }, }); return panel; diff --git a/js/ui/moreMenuController.js b/js/ui/moreMenuController.js index 36a303bf..09053832 100644 --- a/js/ui/moreMenuController.js +++ b/js/ui/moreMenuController.js @@ -348,7 +348,12 @@ export default class MoreMenuController { return modal; } - openReportModal({ eventId, authorPubkey = "", trigger = null } = {}) { + openReportModal({ + eventId, + authorPubkey = "", + relayHint = "", + trigger = null, + } = {}) { const modal = this.ensureReportModal(); if (!modal) { this.callbacks.showError( @@ -357,9 +362,17 @@ export default class MoreMenuController { return false; } + const normalizedEventId = + typeof eventId === "string" ? eventId.trim() : ""; + const normalizedAuthor = + typeof authorPubkey === "string" ? authorPubkey.trim() : ""; + const normalizedRelayHint = + typeof relayHint === "string" ? relayHint.trim() : ""; + this.activeReportContext = { - eventId: typeof eventId === "string" ? eventId : "", - authorPubkey: typeof authorPubkey === "string" ? authorPubkey : "", + eventId: normalizedEventId, + authorPubkey: normalizedAuthor, + relayHint: normalizedRelayHint, }; this.isReportSubmitting = false; this.setReportModalBusy(false); @@ -496,6 +509,15 @@ export default class MoreMenuController { return; } + const targetPubkey = + typeof context.authorPubkey === "string" + ? context.authorPubkey.trim() + : ""; + if (!targetPubkey) { + this.showReportError("Unable to determine which creator to report."); + return; + } + const viewerPubkey = this.callbacks.getCurrentUserPubkey?.(); if (!viewerPubkey) { this.closeReportModal(); @@ -518,7 +540,11 @@ export default class MoreMenuController { await service.submitReport({ eventId, type: category, - targetPubkey: context.authorPubkey || "", + targetPubkey, + relayHint: + typeof context.relayHint === "string" + ? context.relayHint.trim() + : "", }); this.callbacks.showSuccess( @@ -537,6 +563,8 @@ export default class MoreMenuController { message = "Connect a Nostr account before reporting videos."; } else if (code === "service-unavailable") { message = "Reporting is unavailable right now. Please try again later."; + } else if (code === "invalid-target-pubkey") { + message = "Unable to determine which creator to report."; } this.showReportError(message); @@ -1505,11 +1533,14 @@ export default class MoreMenuController { } const eventId = - dataset.eventId || - (context === "modal" ? currentVideo?.id : "") || - currentVideo?.id || ""; + (typeof dataset.eventId === "string" ? dataset.eventId : "") || + (context === "modal" && typeof currentVideo?.id === "string" + ? currentVideo.id + : "") || + (typeof currentVideo?.id === "string" ? currentVideo.id : ""); - if (!eventId) { + const normalizedEventId = eventId ? eventId.trim() : ""; + if (!normalizedEventId) { this.callbacks.showError( "Unable to determine which video to report.", ); @@ -1517,15 +1548,41 @@ export default class MoreMenuController { } const authorPubkey = - dataset.author || - (context === "modal" && currentVideo?.pubkey + (typeof dataset.author === "string" ? dataset.author : "") || + (context === "modal" && typeof currentVideo?.pubkey === "string" ? currentVideo.pubkey : "") || - currentVideo?.pubkey || ""; + (typeof currentVideo?.pubkey === "string" ? currentVideo.pubkey : ""); + + const normalizedAuthor = authorPubkey ? authorPubkey.trim() : ""; + if (!normalizedAuthor) { + this.callbacks.showError( + "Unable to determine which creator to report.", + ); + break; + } + + let relayHint = + (typeof dataset.pointerRelay === "string" + ? dataset.pointerRelay + : "") || ""; + if (relayHint) { + relayHint = relayHint.trim(); + } + if (!relayHint && context === "modal") { + const pointer = Array.isArray(currentVideo?.pointer) + ? currentVideo.pointer + : null; + const hintCandidate = pointer && pointer.length > 2 ? pointer[2] : ""; + if (typeof hintCandidate === "string" && hintCandidate.trim()) { + relayHint = hintCandidate.trim(); + } + } this.openReportModal({ - eventId, - authorPubkey, + eventId: normalizedEventId, + authorPubkey: normalizedAuthor, + relayHint, trigger: dataset.triggerElement || null, }); break; diff --git a/js/ui/profileModalController.js b/js/ui/profileModalController.js index c1fc1bac..fbf2b803 100644 --- a/js/ui/profileModalController.js +++ b/js/ui/profileModalController.js @@ -1132,6 +1132,11 @@ export class ProfileModalController { this.boundFocusIn = null; this.focusableElements = []; this.focusTrapContainer = null; + this.focusTrapSuspended = false; + this.focusTrapSuspendCount = 0; + this.focusTrapAriaHiddenBeforeSuspend = null; + this.focusTrapPointerEventsBeforeSuspend = null; + this.focusTrapVisibilityBeforeSuspend = null; this.profileSwitcherSelectionPubkey = null; this.previouslyFocusedElement = null; this.largeLayoutQuery = null; @@ -2843,6 +2848,26 @@ export class ProfileModalController { this.setAddAccountLoading(true); + try { + this.bringLoginModalToFront(); + } catch (error) { + devLogger.warn( + "[ProfileModalController] Failed to elevate login modal before add profile authentication:", + error, + ); + } + + let suspendedFocusTrap = false; + try { + this.suspendFocusTrap(); + suspendedFocusTrap = true; + } catch (error) { + devLogger.warn( + "[ProfileModalController] Failed to suspend profile modal focus trap before login:", + error, + ); + } + try { const loginResult = await requestLogin({ controller: this, @@ -2884,6 +2909,17 @@ export class ProfileModalController { this.showError(message); } } finally { + if (suspendedFocusTrap) { + try { + this.resumeFocusTrap(); + } catch (error) { + devLogger.warn( + "[ProfileModalController] Failed to resume profile modal focus trap after login:", + error, + ); + } + } + this.setAddAccountLoading(false); } } @@ -8118,6 +8154,11 @@ export class ProfileModalController { return; } + if (this.focusTrapSuspended) { + this.focusTrapContainer = targetContainer; + return; + } + if (!this.boundKeydown) { this.boundKeydown = (event) => { if (event.key === "Escape") { @@ -8198,6 +8239,179 @@ export class ProfileModalController { document.addEventListener("focusin", this.boundFocusIn); } + getModalRootElement() { + if (this.profileModalRoot instanceof HTMLElement) { + return this.profileModalRoot; + } + if (this.profileModal instanceof HTMLElement) { + return this.profileModal; + } + return null; + } + + getModalPanelElement() { + if (this.profileModalPanel instanceof HTMLElement) { + return this.profileModalPanel; + } + return this.getModalRootElement(); + } + + suspendFocusTrap() { + this.focusTrapSuspendCount += 1; + this.focusTrapSuspended = true; + + if (this.focusTrapSuspendCount > 1) { + return this.focusTrapSuspendCount; + } + + if ( + this.boundKeydown && + this.focusTrapContainer instanceof HTMLElement + ) { + this.focusTrapContainer.removeEventListener( + "keydown", + this.boundKeydown, + ); + } + + if (this.boundFocusIn) { + document.removeEventListener("focusin", this.boundFocusIn); + } + + const modalRoot = this.getModalRootElement(); + if (modalRoot) { + this.focusTrapAriaHiddenBeforeSuspend = modalRoot.getAttribute( + "aria-hidden", + ); + this.focusTrapPointerEventsBeforeSuspend = + typeof modalRoot.style.pointerEvents === "string" && + modalRoot.style.pointerEvents + ? modalRoot.style.pointerEvents + : null; + this.focusTrapVisibilityBeforeSuspend = + typeof modalRoot.style.visibility === "string" && + modalRoot.style.visibility + ? modalRoot.style.visibility + : null; + + modalRoot.dataset.nestedModalActive = "true"; + modalRoot.setAttribute("aria-hidden", "true"); + modalRoot.style.setProperty("pointer-events", "none"); + modalRoot.style.setProperty("visibility", "hidden"); + } else { + this.focusTrapAriaHiddenBeforeSuspend = null; + this.focusTrapPointerEventsBeforeSuspend = null; + this.focusTrapVisibilityBeforeSuspend = null; + } + + const panel = this.getModalPanelElement(); + if (panel) { + panel.setAttribute("inert", ""); + } + + return this.focusTrapSuspendCount; + } + + resumeFocusTrap() { + if (this.focusTrapSuspendCount === 0) { + return 0; + } + + this.focusTrapSuspendCount = Math.max( + 0, + this.focusTrapSuspendCount - 1, + ); + + if (this.focusTrapSuspendCount > 0) { + return this.focusTrapSuspendCount; + } + + this.focusTrapSuspended = false; + + const modalRoot = this.getModalRootElement(); + if (modalRoot) { + delete modalRoot.dataset.nestedModalActive; + if (!modalRoot.classList.contains("hidden")) { + if (this.focusTrapAriaHiddenBeforeSuspend === null) { + modalRoot.removeAttribute("aria-hidden"); + } else { + modalRoot.setAttribute( + "aria-hidden", + this.focusTrapAriaHiddenBeforeSuspend, + ); + } + } + + if ( + this.focusTrapPointerEventsBeforeSuspend === null || + this.focusTrapPointerEventsBeforeSuspend === undefined || + this.focusTrapPointerEventsBeforeSuspend === "" + ) { + modalRoot.style.removeProperty("pointer-events"); + } else { + modalRoot.style.setProperty( + "pointer-events", + this.focusTrapPointerEventsBeforeSuspend, + ); + } + + if ( + this.focusTrapVisibilityBeforeSuspend === null || + this.focusTrapVisibilityBeforeSuspend === undefined || + this.focusTrapVisibilityBeforeSuspend === "" + ) { + modalRoot.style.removeProperty("visibility"); + } else { + modalRoot.style.setProperty( + "visibility", + this.focusTrapVisibilityBeforeSuspend, + ); + } + } + + const panel = this.getModalPanelElement(); + if (panel) { + panel.removeAttribute("inert"); + } + + this.focusTrapAriaHiddenBeforeSuspend = null; + this.focusTrapPointerEventsBeforeSuspend = null; + this.focusTrapVisibilityBeforeSuspend = null; + + this.updateFocusTrap(); + + return 0; + } + + bringLoginModalToFront() { + if (typeof document === "undefined") { + return; + } + + const loginModal = document.getElementById("loginModal"); + if (!(loginModal instanceof HTMLElement)) { + return; + } + + const container = + this.modalContainer instanceof HTMLElement + ? this.modalContainer + : loginModal.parentElement; + + if (!container) { + return; + } + + if (loginModal.parentElement !== container) { + container.appendChild(loginModal); + return; + } + + if (container.lastElementChild !== loginModal) { + container.appendChild(loginModal); + } + } + ensureModalOrder(modalRoot) { if (!(modalRoot instanceof HTMLElement)) { return; @@ -8421,6 +8635,9 @@ export class ProfileModalController { if (modalElement) { modalElement.classList.add("hidden"); modalElement.setAttribute("aria-hidden", "true"); + delete modalElement.dataset.nestedModalActive; + modalElement.style.removeProperty("pointer-events"); + modalElement.style.removeProperty("visibility"); this.setGlobalModalState("profile", false); this.setMobileView("menu", { skipFocusTrap: true }); @@ -8436,8 +8653,19 @@ export class ProfileModalController { document.removeEventListener("focusin", this.boundFocusIn); } + const panel = this.getModalPanelElement(); + if (panel) { + panel.removeAttribute("inert"); + } + this.focusTrapContainer = null; + this.focusTrapSuspendCount = 0; + this.focusTrapSuspended = false; + this.focusTrapAriaHiddenBeforeSuspend = null; + this.focusTrapPointerEventsBeforeSuspend = null; + this.focusTrapVisibilityBeforeSuspend = null; + if ( this.boundProfileHistoryVisibility && typeof document !== "undefined" && diff --git a/js/ui/videoModalCommentController.js b/js/ui/videoModalCommentController.js new file mode 100644 index 00000000..5d7f11d3 --- /dev/null +++ b/js/ui/videoModalCommentController.js @@ -0,0 +1,807 @@ +import { devLogger } from "../utils/logger.js"; +import { buildVideoAddressPointer } from "../utils/videoPointer.js"; +import { COMMENT_EVENT_KIND } from "../nostr/commentEvents.js"; + +const DEFAULT_LIMIT = 40; + +function normalizeString(value) { + return typeof value === "string" ? value.trim() : ""; +} + +function normalizeKind(value) { + if (Number.isFinite(value)) { + return String(Math.floor(value)); + } + if (typeof value === "string" && value.trim()) { + return value.trim(); + } + return ""; +} + +export default class VideoModalCommentController { + constructor({ + commentThreadService = null, + videoModal = null, + auth = {}, + callbacks = {}, + services = {}, + utils = {}, + } = {}) { + this.commentThreadService = commentThreadService; + this.videoModal = videoModal; + + this.auth = { + isLoggedIn: + typeof auth.isLoggedIn === "function" ? () => auth.isLoggedIn() : () => false, + initializeLoginModalController: + typeof auth.initializeLoginModalController === "function" + ? (options) => auth.initializeLoginModalController(options) + : () => {}, + getLoginModalController: + typeof auth.getLoginModalController === "function" + ? () => auth.getLoginModalController() + : () => null, + requestLogin: + typeof auth.requestLogin === "function" + ? (options) => auth.requestLogin(options) + : () => Promise.resolve(false), + }; + + this.callbacks = { + showError: + typeof callbacks.showError === "function" + ? (message) => callbacks.showError(message) + : () => {}, + showStatus: + typeof callbacks.showStatus === "function" + ? (message, options) => callbacks.showStatus(message, options) + : () => {}, + muteAuthor: + typeof callbacks.muteAuthor === "function" + ? (pubkey) => callbacks.muteAuthor(pubkey) + : () => Promise.resolve(), + shouldHideAuthor: + typeof callbacks.shouldHideAuthor === "function" + ? (pubkey) => callbacks.shouldHideAuthor(pubkey) + : () => false, + }; + + this.services = { + publishComment: + typeof services.publishComment === "function" + ? (payload, eventData) => services.publishComment(payload, eventData) + : () => Promise.resolve(null), + }; + + this.utils = { + normalizeHexPubkey: + typeof utils.normalizeHexPubkey === "function" + ? (value) => utils.normalizeHexPubkey(value) + : () => null, + }; + + this.currentVideo = null; + this.modalCommentState = { + videoEventId: null, + videoDefinitionAddress: null, + videoKind: null, + videoAuthorPubkey: null, + parentCommentId: null, + parentCommentKind: null, + parentCommentPubkey: null, + }; + this.modalCommentProfiles = new Map(); + this.modalCommentLimit = this.commentThreadService?.defaultLimit || DEFAULT_LIMIT; + this.modalCommentLoadPromise = null; + this.modalCommentPublishPromise = null; + + this.boundThreadReadyHandler = (snapshot) => + this.handleCommentThreadReady(snapshot); + this.boundThreadAppendHandler = (payload) => + this.handleCommentThreadAppend(payload); + this.boundThreadErrorHandler = (error) => + this.handleCommentThreadError(error); + + if (this.commentThreadService?.setCallbacks) { + this.commentThreadService.setCallbacks({ + onThreadReady: this.boundThreadReadyHandler, + onCommentsAppended: this.boundThreadAppendHandler, + onError: this.boundThreadErrorHandler, + }); + } + } + + load(video) { + if (!this.videoModal) { + return; + } + + if (!video) { + this.dispose(); + return; + } + + this.dispose({ resetUi: false }); + this.currentVideo = video; + + this.videoModal.setCommentSectionCallbacks?.({ + teardown: () => this.dispose(), + }); + + if (!this.commentThreadService) { + this.resetModalCommentState(); + return; + } + + this.videoModal.hideCommentsDisabledMessage?.(); + + if (video.enableComments === false) { + this.resetModalCommentState(); + this.videoModal.showCommentsDisabledMessage?.( + "Comments have been turned off for this video.", + ); + return; + } + + const videoEventId = normalizeString(video.id); + let videoDefinitionAddress = buildVideoAddressPointer(video); + if (!videoDefinitionAddress && this.modalCommentState.videoDefinitionAddress) { + videoDefinitionAddress = normalizeString( + this.modalCommentState.videoDefinitionAddress, + ); + } + const videoKind = normalizeKind(video.kind); + const videoAuthorPubkey = normalizeString(video.pubkey); + + if (!videoEventId) { + this.resetModalCommentState({ hide: false }); + this.videoModal.setCommentStatus?.( + "Comments are unavailable for this video.", + ); + return; + } + + this.modalCommentState = { + videoEventId, + videoDefinitionAddress: videoDefinitionAddress || null, + videoKind: videoKind || null, + videoAuthorPubkey: videoAuthorPubkey || null, + parentCommentId: null, + parentCommentKind: null, + parentCommentPubkey: null, + }; + this.modalCommentProfiles = new Map(); + if (this.commentThreadService?.defaultLimit) { + this.modalCommentLimit = this.commentThreadService.defaultLimit; + } + + this.videoModal.setCommentsVisibility?.(true); + this.videoModal.clearComments?.(); + this.videoModal.resetCommentComposer?.(); + this.videoModal.setCommentStatus?.("Loading comments…"); + this.applyCommentComposerAuthState(); + + const loadPromise = this.commentThreadService.loadThread({ + video, + parentCommentId: null, + limit: this.modalCommentLimit, + }); + + if (!loadPromise || typeof loadPromise.then !== "function") { + this.applyCommentComposerAuthState(); + return; + } + + this.modalCommentLoadPromise = loadPromise; + loadPromise + .then(() => { + if (this.modalCommentLoadPromise === loadPromise) { + this.modalCommentLoadPromise = null; + } + this.applyCommentComposerAuthState(); + }) + .catch((error) => { + if (this.modalCommentLoadPromise === loadPromise) { + this.modalCommentLoadPromise = null; + } + this.handleCommentThreadError(error); + }); + } + + submit(detail = {}) { + this.handleVideoModalCommentSubmit(detail); + } + + retry(detail = {}) { + this.handleVideoModalCommentSubmit(detail); + } + + loadMore() { + this.handleVideoModalCommentLoadMore(); + } + + handleLoginRequired(detail = {}) { + this.handleVideoModalCommentLoginRequired(detail); + } + + async muteAuthor(detail = {}) { + await this.handleVideoModalCommentMute(detail); + } + + refreshAuthState() { + this.applyCommentComposerAuthState(); + } + + dispose({ resetUi = true } = {}) { + if (this.commentThreadService) { + try { + this.commentThreadService.teardown(); + } catch (error) { + devLogger.warn("[comment] Failed to teardown modal comment thread:", error); + } + } + + this.modalCommentLoadPromise = null; + this.modalCommentPublishPromise = null; + this.modalCommentState = { + videoEventId: null, + videoDefinitionAddress: null, + videoKind: null, + videoAuthorPubkey: null, + parentCommentId: null, + parentCommentKind: null, + parentCommentPubkey: null, + }; + this.modalCommentProfiles = new Map(); + if (resetUi) { + this.resetModalCommentState(); + } + this.videoModal?.setCommentSectionCallbacks?.({ teardown: null }); + this.currentVideo = null; + } + + destroy({ resetUi = true } = {}) { + this.dispose({ resetUi }); + if (this.commentThreadService?.setCallbacks) { + this.commentThreadService.setCallbacks({ + onThreadReady: null, + onCommentsAppended: null, + onError: null, + }); + } + this.commentThreadService = null; + this.videoModal = null; + } + + resetModalCommentState({ hide = true } = {}) { + if (!this.videoModal) { + return; + } + + this.videoModal.clearComments?.(); + this.videoModal.resetCommentComposer?.(); + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "disabled", + }); + if (hide) { + this.videoModal.setCommentsVisibility?.(false); + } + this.videoModal.setCommentStatus?.(""); + } + + applyCommentComposerAuthState() { + if (!this.videoModal) { + return; + } + + if (!this.modalCommentState.videoEventId) { + return; + } + + if (this.currentVideo?.enableComments === false) { + this.videoModal.showCommentsDisabledMessage?.( + "Comments have been turned off for this video.", + ); + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "disabled", + }); + return; + } + + this.videoModal.hideCommentsDisabledMessage?.(); + + if (!this.auth.isLoggedIn()) { + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "login-required", + }); + return; + } + + this.videoModal.setCommentComposerState?.({ + disabled: false, + reason: "", + }); + this.videoModal.setCommentStatus?.(""); + } + + handleCommentThreadReady(snapshot) { + if (!snapshot || !this.videoModal) { + return; + } + + if (snapshot.videoEventId !== this.modalCommentState.videoEventId) { + return; + } + + this.modalCommentProfiles = this.createMapFromInput(snapshot.profiles); + this.modalCommentState.parentCommentId = normalizeString( + snapshot.parentCommentId, + ) || null; + if (typeof snapshot.videoDefinitionAddress === "string") { + const pointer = normalizeString(snapshot.videoDefinitionAddress); + if (pointer) { + this.modalCommentState.videoDefinitionAddress = pointer; + } + } + const snapshotVideoKind = normalizeKind(snapshot.videoKind); + if (snapshotVideoKind) { + this.modalCommentState.videoKind = snapshotVideoKind; + } + const snapshotVideoAuthor = normalizeString(snapshot.videoAuthorPubkey); + if (snapshotVideoAuthor) { + this.modalCommentState.videoAuthorPubkey = snapshotVideoAuthor; + } + const snapshotParentKind = normalizeKind(snapshot.parentCommentKind); + if (snapshotParentKind) { + this.modalCommentState.parentCommentKind = snapshotParentKind; + } + const snapshotParentPubkey = normalizeString(snapshot.parentCommentPubkey); + if (snapshotParentPubkey) { + this.modalCommentState.parentCommentPubkey = snapshotParentPubkey; + } + + const sanitizedSnapshot = this.buildModalCommentSnapshot(snapshot); + this.videoModal.renderComments?.(sanitizedSnapshot); + this.videoModal.setCommentStatus?.(""); + this.applyCommentComposerAuthState(); + } + + handleCommentThreadAppend(payload) { + if (!payload || !this.videoModal) { + return; + } + + if (payload.videoEventId !== this.modalCommentState.videoEventId) { + return; + } + + const comments = this.createMapFromInput(payload.commentsById); + const profiles = this.createMapFromInput(payload.profiles); + profiles.forEach((profile, pubkey) => { + this.modalCommentProfiles.set(pubkey, profile); + }); + + const commentIds = Array.isArray(payload.commentIds) + ? payload.commentIds + : []; + + commentIds.forEach((commentId) => { + if (!comments.has(commentId)) { + return; + } + const event = comments.get(commentId); + if (!event || this.shouldHideModalComment(event)) { + return; + } + const enriched = this.enrichCommentEvent(event); + if ( + this.modalCommentState.parentCommentId && + commentId === this.modalCommentState.parentCommentId + ) { + const eventKind = normalizeKind(event.kind); + if (eventKind) { + this.modalCommentState.parentCommentKind = eventKind; + } + const eventPubkey = normalizeString(event.pubkey); + if (eventPubkey) { + this.modalCommentState.parentCommentPubkey = eventPubkey; + } + } + this.videoModal.appendComment?.(enriched); + }); + } + + handleCommentThreadError(error) { + if (error) { + devLogger.warn("[comment]", error); + } + if (!this.videoModal) { + return; + } + this.videoModal.setCommentStatus?.( + "Failed to load comments. Please try again later.", + ); + if (!this.auth.isLoggedIn()) { + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "login-required", + }); + } + } + + createMapFromInput(input) { + if (input instanceof Map) { + return new Map(input); + } + const map = new Map(); + if (Array.isArray(input)) { + input.forEach((entry) => { + if (Array.isArray(entry) && entry.length >= 2) { + map.set(entry[0], entry[1]); + } + }); + return map; + } + if (input && typeof input === "object") { + Object.entries(input).forEach(([key, value]) => { + map.set(key, value); + }); + } + return map; + } + + createChildrenMapFromInput(input) { + const source = + input instanceof Map ? input : this.createMapFromInput(input); + const result = new Map(); + source.forEach((value, key) => { + let normalizedKey = key; + if (normalizedKey === null || normalizedKey === undefined) { + normalizedKey = null; + } else if (typeof normalizedKey === "string") { + const trimmed = normalizedKey.trim(); + if ( + !trimmed || + trimmed === "null" || + trimmed === "undefined" || + trimmed === "__root__" + ) { + normalizedKey = null; + } else { + normalizedKey = trimmed; + } + } + const list = Array.isArray(value) ? value.filter(Boolean) : []; + result.set(normalizedKey, list); + }); + return result; + } + + enrichCommentEvent(event) { + const cloned = { ...(event || {}) }; + const normalized = this.utils.normalizeHexPubkey(cloned.pubkey); + if (normalized && this.modalCommentProfiles.has(normalized)) { + cloned.profile = this.modalCommentProfiles.get(normalized); + } + return cloned; + } + + buildModalCommentSnapshot(snapshot) { + const comments = this.createMapFromInput(snapshot?.commentsById); + const children = this.createChildrenMapFromInput( + snapshot?.childrenByParent, + ); + const sanitizedComments = new Map(); + + comments.forEach((event, key) => { + if (!event || this.shouldHideModalComment(event)) { + return; + } + sanitizedComments.set(key, this.enrichCommentEvent(event)); + }); + + const sanitizedChildren = new Map(); + children.forEach((ids, parentId) => { + const seen = new Set(); + const filtered = []; + ids.forEach((id) => { + if (!sanitizedComments.has(id) || seen.has(id)) { + return; + } + seen.add(id); + filtered.push(id); + }); + sanitizedChildren.set(parentId, filtered); + }); + + return { + videoEventId: snapshot.videoEventId, + parentCommentId: snapshot.parentCommentId || null, + commentsById: sanitizedComments, + childrenByParent: sanitizedChildren, + profiles: this.modalCommentProfiles, + }; + } + + shouldHideModalComment(event) { + const normalized = this.utils.normalizeHexPubkey(event?.pubkey); + if (!normalized) { + return false; + } + + try { + return Boolean(this.callbacks.shouldHideAuthor(normalized)); + } catch (error) { + devLogger.warn("[comment] Failed to evaluate comment visibility:", error); + return false; + } + } + + async handleVideoModalCommentSubmit(detail = {}) { + if (this.modalCommentPublishPromise) { + return; + } + + const text = normalizeString(detail.text); + if (!text) { + return; + } + + if (!this.auth.isLoggedIn()) { + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "login-required", + }); + this.handleVideoModalCommentLoginRequired(detail); + return; + } + + const video = this.currentVideo; + if (!video || video.enableComments === false) { + return; + } + + const videoEventId = normalizeString(video.id); + let videoDefinitionAddress = buildVideoAddressPointer(video); + if (!videoDefinitionAddress && this.modalCommentState.videoDefinitionAddress) { + videoDefinitionAddress = normalizeString( + this.modalCommentState.videoDefinitionAddress, + ); + } + const videoKind = + this.modalCommentState.videoKind || normalizeKind(video.kind); + const videoAuthorPubkey = + this.modalCommentState.videoAuthorPubkey || normalizeString(video.pubkey); + + if (!videoEventId) { + this.callbacks.showError("Comments are unavailable for this video."); + return; + } + + const parentCommentId = normalizeString(detail.parentId) || null; + let parentCommentKind = this.modalCommentState.parentCommentKind + ? normalizeKind(this.modalCommentState.parentCommentKind) + : ""; + let parentCommentPubkey = this.modalCommentState.parentCommentPubkey + ? normalizeString(this.modalCommentState.parentCommentPubkey) + : ""; + + if (parentCommentId && typeof this.commentThreadService?.getCommentEvent === "function") { + const parentEvent = this.commentThreadService.getCommentEvent( + parentCommentId, + ); + if (parentEvent) { + const eventKind = normalizeKind(parentEvent.kind); + if (eventKind) { + parentCommentKind = eventKind; + this.modalCommentState.parentCommentKind = eventKind; + } + const eventPubkey = normalizeString(parentEvent.pubkey); + if (eventPubkey) { + parentCommentPubkey = eventPubkey; + this.modalCommentState.parentCommentPubkey = eventPubkey; + } + } + } + + if (!parentCommentKind && parentCommentId) { + parentCommentKind = String(COMMENT_EVENT_KIND); + } + + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "submitting", + }); + + const publishPayload = { + videoEventId, + parentCommentId, + }; + + if (videoDefinitionAddress) { + publishPayload.videoDefinitionAddress = videoDefinitionAddress; + } + if (videoKind) { + publishPayload.videoKind = videoKind; + publishPayload.rootKind = videoKind; + } + if (videoAuthorPubkey) { + publishPayload.videoAuthorPubkey = videoAuthorPubkey; + publishPayload.rootAuthorPubkey = videoAuthorPubkey; + } + if (parentCommentKind) { + publishPayload.parentCommentKind = parentCommentKind; + } + if (parentCommentPubkey) { + publishPayload.parentCommentPubkey = parentCommentPubkey; + publishPayload.parentAuthorPubkey = parentCommentPubkey; + } + + const publishPromise = Promise.resolve( + this.services.publishComment( + publishPayload, + { + content: text, + }, + ), + ); + + this.modalCommentPublishPromise = publishPromise; + + try { + const result = await publishPromise; + if (!result?.ok || !result.event) { + throw result || { error: "publish-failed" }; + } + + const event = this.enrichCommentEvent(result.event); + if (this.commentThreadService) { + try { + this.commentThreadService.processIncomingEvent(event); + } catch (error) { + devLogger.warn( + "[comment] Failed to process optimistic comment event:", + error, + ); + this.videoModal.appendComment?.(event); + } + } else { + this.videoModal.appendComment?.(event); + } + + this.videoModal.resetCommentComposer?.(); + this.applyCommentComposerAuthState(); + this.videoModal.setCommentStatus?.("Comment posted."); + } catch (error) { + const authRequired = + (error && typeof error === "object" && error.error === "auth-required") || + error === "auth-required"; + + if (authRequired) { + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "login-required", + }); + this.handleVideoModalCommentLoginRequired(detail); + this.videoModal.setCommentComposerState?.({ + disabled: true, + reason: "login-required", + }); + return; + } + + devLogger.warn("[comment] Failed to publish comment:", error); + this.videoModal.setCommentComposerState?.({ + disabled: false, + reason: "error", + }); + this.callbacks.showError("Failed to post comment. Please try again."); + } finally { + if (this.modalCommentPublishPromise === publishPromise) { + this.modalCommentPublishPromise = null; + } + } + } + + handleVideoModalCommentLoadMore() { + if (!this.commentThreadService || !this.currentVideo) { + return; + } + + if (this.modalCommentLoadPromise) { + return; + } + + const increment = this.commentThreadService.defaultLimit || DEFAULT_LIMIT; + this.modalCommentLimit = (this.modalCommentLimit || increment) + increment; + + const loadPromise = this.commentThreadService.loadThread({ + video: this.currentVideo, + parentCommentId: this.modalCommentState.parentCommentId, + limit: this.modalCommentLimit, + }); + + if (!loadPromise || typeof loadPromise.then !== "function") { + return; + } + + this.modalCommentLoadPromise = loadPromise; + loadPromise + .then(() => { + if (this.modalCommentLoadPromise === loadPromise) { + this.modalCommentLoadPromise = null; + } + this.applyCommentComposerAuthState(); + }) + .catch((error) => { + if (this.modalCommentLoadPromise === loadPromise) { + this.modalCommentLoadPromise = null; + } + devLogger.warn("[comment] Failed to load more comments:", error); + this.callbacks.showError( + "Failed to load more comments. Please try again.", + ); + }); + } + + handleVideoModalCommentLoginRequired(detail = {}) { + this.applyCommentComposerAuthState(); + try { + this.auth.initializeLoginModalController({ logIfMissing: true }); + } catch (error) { + devLogger.warn( + "[comment] Failed to initialize login modal controller:", + error, + ); + } + + const triggerElement = detail?.triggerElement || null; + try { + const loginModalController = this.auth.getLoginModalController(); + if ( + loginModalController && + typeof loginModalController.openModal === "function" + ) { + const opened = loginModalController.openModal({ triggerElement }); + if (opened) { + return; + } + } + } catch (error) { + devLogger.warn("[comment] Failed to open login modal:", error); + } + + Promise.resolve( + this.auth.requestLogin({ allowAccountSelection: true }), + ).catch((error) => { + devLogger.warn("[comment] Login request failed:", error); + }); + } + + async handleVideoModalCommentMute(detail = {}) { + const pubkey = normalizeString(detail?.pubkey); + if (!pubkey) { + return; + } + + if (!this.auth.isLoggedIn()) { + this.handleVideoModalCommentLoginRequired(detail); + return; + } + + try { + await Promise.resolve(this.callbacks.muteAuthor(pubkey)); + const snapshot = this.commentThreadService?.getSnapshot?.(); + if (snapshot) { + this.handleCommentThreadReady(snapshot); + } + this.callbacks.showStatus?.("Author muted."); + } catch (error) { + devLogger.warn("[comment] Failed to mute author:", error); + this.callbacks.showError("Failed to mute this author. Please try again."); + } + } +} diff --git a/js/ui/views/VideoListView.js b/js/ui/views/VideoListView.js index 09be79bb..8aed5849 100644 --- a/js/ui/views/VideoListView.js +++ b/js/ui/views/VideoListView.js @@ -2,6 +2,7 @@ import { VideoCard } from "../components/VideoCard.js"; import { renderTagPillStrip, applyTagPreferenceState, + trimTagPillStripToFit, } from "../components/tagPillList.js"; import { subscribeToVideoViewCount, @@ -181,6 +182,18 @@ export class VideoListView { this._lastRenderedVideoListElement = null; this.popularTagsRoot = null; this._popularTagStrip = null; + this._popularTagsSortedList = []; + this._popularTagResizeObserver = null; + this._popularTagResizeHandler = null; + this._popularTagResizeCancel = null; + this._popularTagResizeScheduled = false; + this._isApplyingPopularTagTrim = false; + this._handlePopularTagResize = () => { + if (this._isApplyingPopularTagTrim) { + return; + } + this.renderPopularTagStrip(); + }; this.handlers = { playback: null, @@ -268,12 +281,14 @@ export class VideoListView { this.currentVideos = []; this.lastRenderedVideoSignature = null; this._lastRenderedVideoListElement = null; + this._teardownPopularTagResizeObserver(); if (this.popularTagsRoot) { this.popularTagsRoot.textContent = ""; this.popularTagsRoot.hidden = true; } this.popularTagsRoot = null; this._popularTagStrip = null; + this._popularTagsSortedList = []; } setPlaybackHandler(handler) { @@ -320,6 +335,7 @@ export class VideoListView { } setPopularTagsContainer(container) { + this._teardownPopularTagResizeObserver(); if (this.popularTagsRoot && this.popularTagsRoot !== container) { this.popularTagsRoot.textContent = ""; this.popularTagsRoot.hidden = true; @@ -331,6 +347,10 @@ export class VideoListView { if (this.popularTagsRoot) { this.popularTagsRoot.textContent = ""; this.popularTagsRoot.hidden = true; + if (this._popularTagsSortedList.length) { + this.renderPopularTagStrip(); + this._ensurePopularTagResizeObserver(); + } } } @@ -341,9 +361,9 @@ export class VideoListView { } if (!Array.isArray(videos) || videos.length === 0) { - root.textContent = ""; - root.hidden = true; - this._popularTagStrip = null; + this._popularTagsSortedList = []; + this.renderPopularTagStrip(); + this._teardownPopularTagResizeObserver(); return; } @@ -365,9 +385,9 @@ export class VideoListView { }); if (!counts.size) { - root.textContent = ""; - root.hidden = true; - this._popularTagStrip = null; + this._popularTagsSortedList = []; + this.renderPopularTagStrip(); + this._teardownPopularTagResizeObserver(); return; } @@ -388,26 +408,150 @@ export class VideoListView { return lowerA.localeCompare(lowerB); }); - const tags = tagEntries.map((entry) => entry.tag); - const doc = this.document || root.ownerDocument || null; - if (!doc) { - root.textContent = ""; - root.hidden = true; - this._popularTagStrip = null; + this._popularTagsSortedList = tagEntries.map((entry) => entry.tag); + this.renderPopularTagStrip(); + if (this._popularTagsSortedList.length) { + this._ensurePopularTagResizeObserver(); + } else { + this._teardownPopularTagResizeObserver(); + } + } + + renderPopularTagStrip() { + const root = this.popularTagsRoot; + if (!root) { return; } - const { root: strip } = renderTagPillStrip({ - document: doc, - tags, - onTagActivate: (tag, detail = {}) => - this.handlePopularTagActivate(tag, detail), - getTagState: (tag) => this.resolveTagPreferenceState(tag), - }); - root.textContent = ""; - root.appendChild(strip); - root.hidden = false; - this._popularTagStrip = strip; + const tags = Array.isArray(this._popularTagsSortedList) + ? [...this._popularTagsSortedList] + : []; + + this._isApplyingPopularTagTrim = true; + + try { + root.textContent = ""; + this._popularTagStrip = null; + + if (!tags.length) { + root.hidden = true; + return; + } + + const doc = this.document || root.ownerDocument || null; + if (!doc) { + root.hidden = true; + this._teardownPopularTagResizeObserver(); + return; + } + + const { root: strip } = renderTagPillStrip({ + document: doc, + tags, + onTagActivate: (tag, detail = {}) => + this.handlePopularTagActivate(tag, detail), + getTagState: (tag) => this.resolveTagPreferenceState(tag), + }); + + root.appendChild(strip); + this._popularTagStrip = strip; + trimTagPillStripToFit({ strip, container: root }); + root.hidden = strip.childElementCount === 0; + } finally { + this._isApplyingPopularTagTrim = false; + } + } + + _ensurePopularTagResizeObserver() { + const root = this.popularTagsRoot; + if (!root || this._popularTagResizeObserver || this._popularTagResizeHandler) { + return; + } + + const resizeObserverCtor = + (this.window && this.window.ResizeObserver) || + (typeof globalThis !== "undefined" ? globalThis.ResizeObserver : null); + + if (typeof resizeObserverCtor === "function") { + this._popularTagResizeObserver = new resizeObserverCtor(() => { + this._handlePopularTagResize(); + }); + this._popularTagResizeObserver.observe(root); + return; + } + + if (!this.window) { + return; + } + + const schedule = (callback) => { + if (this._popularTagResizeScheduled) { + return; + } + this._popularTagResizeScheduled = true; + + if (typeof this.window.requestAnimationFrame === "function") { + const frameId = this.window.requestAnimationFrame(() => { + this._popularTagResizeScheduled = false; + this._popularTagResizeCancel = null; + callback(); + }); + this._popularTagResizeCancel = () => { + this.window.cancelAnimationFrame(frameId); + this._popularTagResizeCancel = null; + this._popularTagResizeScheduled = false; + }; + } else { + const timeoutId = this.window.setTimeout(() => { + this._popularTagResizeScheduled = false; + this._popularTagResizeCancel = null; + callback(); + }, 50); + this._popularTagResizeCancel = () => { + this.window.clearTimeout(timeoutId); + this._popularTagResizeCancel = null; + this._popularTagResizeScheduled = false; + }; + } + }; + + const handler = () => { + schedule(() => { + if (!this.popularTagsRoot) { + return; + } + this._handlePopularTagResize(); + }); + }; + + this.window.addEventListener("resize", handler); + this._popularTagResizeHandler = handler; + } + + _teardownPopularTagResizeObserver() { + if (this._popularTagResizeObserver) { + try { + this._popularTagResizeObserver.disconnect(); + } catch (error) { + // Ignore disconnect errors. + } + } + this._popularTagResizeObserver = null; + + if (this._popularTagResizeHandler && this.window) { + this.window.removeEventListener("resize", this._popularTagResizeHandler); + } + this._popularTagResizeHandler = null; + + if (typeof this._popularTagResizeCancel === "function") { + try { + this._popularTagResizeCancel(); + } catch (error) { + // Ignore cancellation errors. + } + } + this._popularTagResizeCancel = null; + this._popularTagResizeScheduled = false; } render(videos, metadata = null) { @@ -556,6 +700,34 @@ export class VideoListView { this.utils.persistWatchHistoryMetadata(video, pointerInfo); } + const identity = { + name: + typeof video.creatorName === "string" && video.creatorName + ? video.creatorName + : typeof video.authorName === "string" + ? video.authorName + : "", + picture: + typeof video.creatorPicture === "string" && video.creatorPicture + ? video.creatorPicture + : typeof video.authorPicture === "string" + ? video.authorPicture + : "", + pubkey: typeof video.pubkey === "string" ? video.pubkey : "", + npub: + typeof video.npub === "string" && video.npub + ? video.npub + : typeof video.authorNpub === "string" + ? video.authorNpub + : "", + shortNpub: + typeof video.shortNpub === "string" && video.shortNpub + ? video.shortNpub + : typeof video.creatorNpub === "string" + ? video.creatorNpub + : "", + }; + const videoCard = new VideoCard({ document: this.document, video, @@ -566,6 +738,7 @@ export class VideoListView { postedAt: normalizedPostedAt, cardState, motionState, + identity, nsfwContext: { isNsfw: video?.isNsfw === true, allowNsfw: this.allowNsfw, diff --git a/js/ui/zapController.js b/js/ui/zapController.js index 4587cf90..8aa302a2 100644 --- a/js/ui/zapController.js +++ b/js/ui/zapController.js @@ -7,10 +7,12 @@ import { getCachedLightningEntry, getCachedMetadataByUrl, getCachedPlatformLightningAddress, + isZapAllowanceExhaustedError, isMetadataEntryFresh, normalizeLightningAddressKey, rememberLightningMetadata, setCachedPlatformLightningAddress, + buildZapAllowanceExhaustedMessage, validateInvoiceAmount, } from "../payments/zapSharedState.js"; import { @@ -23,6 +25,7 @@ import { devLogger, userLogger } from "../utils/logger.js"; import { ensureWallet as ensureWalletDefault, sendPayment as sendPaymentDefault, + resetWalletClient as resetWalletClientDefault, } from "../payments/nwcClient.js"; const DEFAULT_SPLIT_SUMMARY = "Enter an amount to view the split."; @@ -243,6 +246,146 @@ export default class ZapController { const { context, result } = attempt; const receipts = Array.isArray(result?.receipts) ? result.receipts : []; + + const failureReceipts = receipts.filter((receipt) => { + if (!receipt || typeof receipt !== "object") { + return false; + } + if (typeof receipt.status === "string" && receipt.status !== "success") { + return true; + } + return Boolean(receipt.error); + }); + + if (failureReceipts.length) { + this.videoModal?.renderZapReceipts(receipts, { partial: true }); + + const failureShares = failureReceipts + .map((receipt) => { + const amount = Math.max(0, Math.round(Number(receipt.amount) || 0)); + return { + type: receipt.recipientType || receipt.type || "creator", + amount, + address: + typeof receipt.address === "string" && receipt.address + ? receipt.address + : undefined, + error: receipt.error, + }; + }) + .filter((share) => share.amount > 0); + + if (failureShares.length) { + this.markRetryPending(failureShares, trimmedComment); + } + + const shareSummary = failureShares + .map((share) => { + const label = + share.type === "platform" + ? "Platform" + : share.type === "creator" + ? "Creator" + : "Lightning"; + return `${label} ${share.amount} sats`; + }) + .join(", "); + + const failureMessage = failureReceipts + .map((receipt) => { + if (typeof receipt?.error?.message === "string") { + return receipt.error.message; + } + if (typeof receipt?.error === "string") { + return receipt.error; + } + return ""; + }) + .find((message) => message); + + const budgetReceipt = failureReceipts.find((receipt) => + isZapAllowanceExhaustedError(receipt?.error) + ); + const isBudgetExceeded = + Boolean(budgetReceipt) || + (typeof failureMessage === "string" && + /budget exceeded/i.test(failureMessage)); + + let warningMessage; + if (isBudgetExceeded) { + warningMessage = + "Budget exceeded. Increase your wallet zap limit or reduce the platform fee, then retry the remaining shares."; + } else if (failureMessage) { + warningMessage = failureMessage; + } else { + warningMessage = + "Some zap shares failed. Press Send again to retry the remaining shares."; + } + + if (shareSummary) { + const normalized = warningMessage.replace(/\.*$/, ""); + warningMessage = `${normalized}. Remaining share(s): ${shareSummary}.`; + } + + this.videoModal?.setZapStatus(warningMessage, "warning"); + this.notifyError(warningMessage); + return; + } + + const unvalidatedReceipts = receipts.filter((receipt) => { + if (!receipt || typeof receipt !== "object") { + return false; + } + const status = + typeof receipt.status === "string" ? receipt.status.toLowerCase() : "success"; + if (status !== "success" && status !== "") { + return false; + } + const validationStatus = + typeof receipt.validation?.status === "string" + ? receipt.validation.status.toLowerCase() + : ""; + if (!validationStatus || validationStatus === "skipped") { + return false; + } + return validationStatus !== "passed"; + }); + + if (unvalidatedReceipts.length) { + this.videoModal?.renderZapReceipts(receipts, { partial: true }); + + const warningSummary = unvalidatedReceipts + .map((receipt) => { + const type = receipt.recipientType || receipt.type || "creator"; + const label = + type === "platform" ? "Platform" : type === "creator" ? "Creator" : "Lightning"; + const address = + typeof receipt.address === "string" && receipt.address + ? ` (${receipt.address})` + : ""; + const reason = + typeof receipt.validation?.reason === "string" && receipt.validation.reason + ? ` — ${receipt.validation.reason}` + : " — Awaiting compliant receipt."; + return `${label}${address}${reason}`; + }) + .join(" "); + + const warningMessage = warningSummary + ? `Awaiting validated zap receipt. ${warningSummary}` + : "Awaiting validated zap receipt from the recipient."; + + this.videoModal?.setZapStatus(warningMessage, "warning"); + this.notifyError(warningMessage); + + this.resetRetryState(); + this.modalZapCommentValue = ""; + this.videoModal?.resetZapForm({ amount: "", comment: "" }); + this.videoModal?.setZapCompleted(true); + this.applyDefaultAmount(); + return; + } + this.videoModal?.renderZapReceipts(receipts, { partial: false }); const creatorShare = context.shares.creatorShare; @@ -474,6 +617,10 @@ export default class ZapController { typeof this.payments?.sendPayment === "function" ? (bolt11, params) => this.payments.sendPayment(bolt11, params) : (bolt11, params) => sendPaymentDefault(bolt11, params); + const resetWalletClientFn = + typeof this.payments?.resetWalletClient === "function" + ? () => this.payments.resetWalletClient() + : () => resetWalletClientDefault(); let activeShare = null; @@ -543,50 +690,59 @@ export default class ZapController { } }, sendPayment: async (bolt11, params) => { - try { - const payment = await sendPaymentFn(bolt11, params); - if (Array.isArray(shareTracker)) { - const shareType = activeShare || "unknown"; - const amount = - shareType === "platform" - ? shares.platformShare - : shares.creatorShare; - const address = - shareType === "platform" - ? platformEntry?.address || getCachedPlatformLightningAddress() - : creatorEntry?.address || lightningAddress; - shareTracker.push({ - type: shareType, + const shareType = activeShare || "unknown"; + const amount = + shareType === "platform" + ? shares.platformShare + : shares.creatorShare; + const address = + shareType === "platform" + ? platformEntry?.address || getCachedPlatformLightningAddress() + : creatorEntry?.address || lightningAddress; + try { + const payment = await sendPaymentFn(bolt11, params); + if (Array.isArray(shareTracker)) { + shareTracker.push({ + type: shareType, status: "success", amount, address, payment, - }); - } - return payment; - } catch (error) { - if (Array.isArray(shareTracker)) { - const shareType = activeShare || "unknown"; - const amount = - shareType === "platform" - ? shares.platformShare - : shares.creatorShare; - const address = - shareType === "platform" - ? platformEntry?.address || getCachedPlatformLightningAddress() - : creatorEntry?.address || lightningAddress; - shareTracker.push({ - type: shareType, - status: "error", - amount, - address, - error, - }); + }); + } + return payment; + } catch (error) { + const allowanceExhausted = isZapAllowanceExhaustedError(error); + if (allowanceExhausted) { + error.__zapAllowanceExhausted = true; + } + if (Array.isArray(shareTracker)) { + shareTracker.push({ + type: shareType, + status: "error", + amount, + address, + error, + allowanceExhausted, + }); + } + if ( + typeof error?.message === "string" && + error.message.toLowerCase().includes("timed out") + ) { + try { + resetWalletClientFn(); + } catch (resetError) { + devLogger.warn( + "[zap] Failed to reset wallet client after timeout", + resetError + ); + } } logZapError( "wallet.sendPayment", { - shareType: activeShare || "unknown", + shareType, amount, address, tracker: shareTracker, @@ -973,31 +1129,65 @@ export default class ZapController { const failureShares = tracker.filter( (entry) => entry && entry.status !== "success" && entry.amount > 0 ); + const allowanceExhausted = + isZapAllowanceExhaustedError(error) || + failureShares.some((share) => + isZapAllowanceExhaustedError(share?.error) + ); + if (allowanceExhausted) { + this.resetRetryState(); + } + if (failureShares.length) { - this.markRetryPending(failureShares, comment); - const summary = failureShares - .map((share) => { - const label = - share.type === "platform" - ? "Platform" - : share.type === "creator" - ? "Creator" - : "Lightning"; - return `${label} ${share.amount} sats`; - }) - .join(", "); - const tone = tracker.length > failureShares.length ? "warning" : "error"; - const statusMessage = - tracker.length > failureShares.length - ? `Partial zap failure. Press Send again to retry: ${summary}.` - : `Zap failed. Press Send again to retry: ${summary}.`; - this.videoModal?.setZapStatus(statusMessage, tone); - this.notifyError(error?.message || statusMessage); + if (allowanceExhausted) { + const allowanceShare = failureShares.find((share) => + isZapAllowanceExhaustedError(share?.error) + ); + const allowanceSource = isZapAllowanceExhaustedError(error) + ? error + : allowanceShare?.error; + const allowanceMessage = buildZapAllowanceExhaustedMessage( + allowanceSource + ); + const partialSuccess = tracker.length > failureShares.length; + const tone = partialSuccess ? "warning" : "error"; + const statusMessage = partialSuccess + ? `Some zap shares succeeded before your wallet allowance was exhausted. ${allowanceMessage}` + : allowanceMessage; + this.videoModal?.setZapStatus(statusMessage, tone); + this.notifyError(statusMessage); + } else { + this.markRetryPending(failureShares, comment); + const summary = failureShares + .map((share) => { + const label = + share.type === "platform" + ? "Platform" + : share.type === "creator" + ? "Creator" + : "Lightning"; + return `${label} ${share.amount} sats`; + }) + .join(", "); + const tone = tracker.length > failureShares.length ? "warning" : "error"; + const statusMessage = + tracker.length > failureShares.length + ? `Partial zap failure. Press Send again to retry: ${summary}.` + : `Zap failed. Press Send again to retry: ${summary}.`; + this.videoModal?.setZapStatus(statusMessage, tone); + this.notifyError(error?.message || statusMessage); + } } else { this.resetRetryState(); - const message = error?.message || "Zap failed. Please try again."; - this.videoModal?.setZapStatus(message, "error"); - this.notifyError(message); + if (allowanceExhausted) { + const allowanceMessage = buildZapAllowanceExhaustedMessage(error); + this.videoModal?.setZapStatus(allowanceMessage, "error"); + this.notifyError(allowanceMessage); + } else { + const message = error?.message || "Zap failed. Please try again."; + this.videoModal?.setZapStatus(message, "error"); + this.notifyError(message); + } } } diff --git a/js/userBlocks.js b/js/userBlocks.js index 6dbb0ab1..329cfe2c 100644 --- a/js/userBlocks.js +++ b/js/userBlocks.js @@ -68,6 +68,305 @@ const BLOCKLIST_STORAGE_PREFIX = "bitvid:user-blocks"; const BLOCKLIST_SEEDED_KEY_PREFIX = `${BLOCKLIST_STORAGE_PREFIX}:seeded:v1`; const BLOCKLIST_REMOVALS_KEY_PREFIX = `${BLOCKLIST_STORAGE_PREFIX}:removals:v1`; +function normalizeEncryptionToken(value) { + if (typeof value !== "string") { + return ""; + } + return value + .trim() + .toLowerCase() + .replace(/[^a-z0-9]/g, ""); +} + +function extractEncryptionHints(event) { + if (!event || typeof event !== "object") { + return []; + } + + const tags = Array.isArray(event.tags) ? event.tags : []; + const hints = []; + + const pushUnique = (scheme) => { + if (!scheme || hints.includes(scheme)) { + return; + } + hints.push(scheme); + }; + + for (const tag of tags) { + if (!Array.isArray(tag) || tag.length < 2) { + continue; + } + const name = typeof tag[0] === "string" ? tag[0].trim().toLowerCase() : ""; + if (name !== "encrypted" && name !== "encryption") { + continue; + } + const rawValue = typeof tag[1] === "string" ? tag[1] : ""; + if (!rawValue) { + continue; + } + const parts = rawValue + .split(/[\s,]+/) + .map((part) => normalizeEncryptionToken(part)) + .filter(Boolean); + + for (const part of parts) { + if (part === "nip44v2" || part === "nip44v02") { + pushUnique("nip44_v2"); + continue; + } + if (part === "nip44") { + pushUnique("nip44"); + continue; + } + if (part === "nip04" || part === "nip4") { + pushUnique("nip04"); + } + } + } + + return hints; +} + +function determineDecryptionOrder(event, availableSchemes) { + const available = Array.isArray(availableSchemes) ? availableSchemes : []; + const availableSet = new Set(available); + const prioritized = []; + + const hints = extractEncryptionHints(event); + const aliasMap = { + nip04: ["nip04"], + nip44: ["nip44", "nip44_v2"], + nip44_v2: ["nip44_v2", "nip44"], + }; + + for (const hint of hints) { + const candidates = Array.isArray(aliasMap[hint]) ? aliasMap[hint] : [hint]; + for (const candidate of candidates) { + if (availableSet.has(candidate) && !prioritized.includes(candidate)) { + prioritized.push(candidate); + break; + } + } + } + + for (const fallback of ["nip44_v2", "nip44", "nip04"]) { + if (availableSet.has(fallback) && !prioritized.includes(fallback)) { + prioritized.push(fallback); + } + } + + return prioritized.length ? prioritized : available; +} + +function describeDiscardedEntry(entry) { + if (typeof entry === "string") { + return entry.trim(); + } + + if (entry === null) { + return "null"; + } + + if (typeof entry === "undefined") { + return "undefined"; + } + + if (Array.isArray(entry)) { + try { + return JSON.stringify(entry); + } catch (_error) { + return String(entry); + } + } + + if (typeof entry === "object") { + try { + return JSON.stringify(entry); + } catch (_error) { + return String(entry); + } + } + + return String(entry); +} + +function sanitizeMuteTags(values, ownerPubkey, options = {}) { + const logDiscarded = options?.logDiscarded !== false; + const owner = normalizeHex(ownerPubkey); + const sanitized = []; + const seen = new Set(); + + const iterable = Array.isArray(values) + ? values + : values instanceof Set + ? Array.from(values) + : values && typeof values[Symbol.iterator] === "function" + ? Array.from(values) + : []; + + const logDiscard = (entry, reason, extra) => { + if (!logDiscarded) { + return; + } + const detail = describeDiscardedEntry(entry); + if (extra) { + userLogger.warn( + `[UserBlockList] Discarded block entry (${reason}).`, + detail, + extra, + ); + return; + } + userLogger.warn(`[UserBlockList] Discarded block entry (${reason}).`, detail); + }; + + for (const entry of iterable) { + let targetHex = null; + + if (Array.isArray(entry)) { + if (entry.length < 2) { + logDiscard(entry, "invalid-tuple"); + continue; + } + + const label = + typeof entry[0] === "string" ? entry[0].trim().toLowerCase() : ""; + if (label !== "p") { + logDiscard(entry, "unsupported-tag"); + continue; + } + + targetHex = normalizeHex(entry[1]); + if (!targetHex) { + logDiscard(entry, "invalid-target"); + continue; + } + } else if (typeof entry === "string") { + targetHex = normalizeHex(entry); + if (!targetHex) { + logDiscard(entry, "invalid-string"); + continue; + } + } else if (entry && typeof entry === "object") { + if (typeof entry.pubkey === "string") { + targetHex = normalizeHex(entry.pubkey); + if (!targetHex) { + logDiscard(entry, "invalid-object-pubkey"); + continue; + } + } else { + logDiscard(entry, "unsupported-entry"); + continue; + } + } else { + logDiscard(entry, "unsupported-entry"); + continue; + } + + if (owner && targetHex === owner) { + logDiscard(entry, "self-target"); + continue; + } + + if (seen.has(targetHex)) { + logDiscard(entry, "duplicate", targetHex); + continue; + } + + seen.add(targetHex); + sanitized.push(["p", targetHex]); + } + + return sanitized; +} + +function serializeBlockListTagMatrix(values, ownerPubkey, options = {}) { + const tags = sanitizeMuteTags(values, ownerPubkey, options); + return JSON.stringify(tags); +} + +function parseBlockListPlaintext(plaintext, ownerPubkey) { + if (typeof plaintext !== "string" || !plaintext) { + return []; + } + + let parsed; + try { + parsed = JSON.parse(plaintext); + } catch (error) { + userLogger.warn( + "[UserBlockList] Failed to parse block list ciphertext as JSON; treating as empty.", + error, + ); + return []; + } + + const owner = normalizeHex(ownerPubkey); + + const extractFromTags = (tags) => { + const collected = []; + const seen = new Set(); + for (const entry of tags) { + if (!Array.isArray(entry) || entry.length < 2) { + continue; + } + const label = typeof entry[0] === "string" ? entry[0].trim().toLowerCase() : ""; + if (label !== "p") { + continue; + } + const normalized = normalizeHex(entry[1]); + if (!normalized || normalized === owner || seen.has(normalized)) { + continue; + } + seen.add(normalized); + collected.push(normalized); + } + return collected; + }; + + if (Array.isArray(parsed)) { + return extractFromTags(parsed); + } + + if (parsed && typeof parsed === "object") { + if (Array.isArray(parsed.tags) && parsed.tags.length) { + return extractFromTags(parsed.tags); + } + + const legacy = Array.isArray(parsed.blockedPubkeys) ? parsed.blockedPubkeys : []; + return legacy + .map((value) => normalizeHex(value)) + .filter((value) => value && value !== owner); + } + + return []; +} + +function isUserBlockListEvent(event) { + if (!event || typeof event.kind !== "number") { + return false; + } + + if (event.kind === 10000) { + return true; + } + + if (event.kind === 30002) { + const tags = Array.isArray(event.tags) ? event.tags : []; + return tags.some( + (tag) => + Array.isArray(tag) && + typeof tag[0] === "string" && + tag[0].trim().toLowerCase() === "d" && + typeof tag[1] === "string" && + tag[1].trim() === BLOCK_LIST_IDENTIFIER, + ); + } + + return false; +} + function decodeNpubToHex(npub) { if (typeof npub !== "string") { return null; @@ -343,63 +642,115 @@ class UserBlockListManager { }); }; - const activeSigner = getActiveSigner(); - const signerDecryptor = - activeSigner && typeof activeSigner.nip04Decrypt === "function" - ? activeSigner.nip04Decrypt - : null; + const resolveDecryptors = async (event) => { + const signer = getActiveSigner(); + const signerHasNip04 = typeof signer?.nip04Decrypt === "function"; + const signerHasNip44 = typeof signer?.nip44Decrypt === "function"; - let extensionDecryptor = - typeof window?.nostr?.nip04?.decrypt === "function" - ? (pubkey, payload) => window.nostr.nip04.decrypt(pubkey, payload) - : null; + const hints = extractEncryptionHints(event); + const requiresNip44 = hints.includes("nip44") || hints.includes("nip44_v2"); + const requiresNip04 = !hints.length || hints.includes("nip04"); - if (!signerDecryptor && !extensionDecryptor) { - const permissionResult = await requestDefaultExtensionPermissions(); - if (!permissionResult.ok) { - userLogger.warn( - "[UserBlockList] Unable to load block list via extension decryptor; permissions denied.", - permissionResult.error, - ); - this.reset(); - this.loaded = true; - const error = - permissionResult.error instanceof Error - ? permissionResult.error - : new Error( - "Extension permissions are required to use the browser decryptor.", - ); - emitStatus({ status: "error", error, decryptor: "extension" }); - emitStatus({ status: "settled" }); - return; + let permissionError = null; + if ((!signerHasNip44 && requiresNip44) || (!signerHasNip04 && requiresNip04)) { + try { + const permissionResult = await requestDefaultExtensionPermissions(); + if (!permissionResult?.ok) { + permissionError = + permissionResult?.error instanceof Error + ? permissionResult.error + : new Error( + "Extension permissions are required to use the browser decryptor.", + ); + } + } catch (error) { + permissionError = error instanceof Error ? error : new Error(String(error)); + } } - extensionDecryptor = - typeof window?.nostr?.nip04?.decrypt === "function" - ? (pubkey, payload) => window.nostr.nip04.decrypt(pubkey, payload) - : null; - } + const decryptors = new Map(); + const sources = new Map(); + const registerDecryptor = (scheme, handler, source) => { + if (!scheme || typeof handler !== "function" || decryptors.has(scheme)) { + return; + } + decryptors.set(scheme, handler); + sources.set(scheme, source || "unknown"); + }; - if (!signerDecryptor && !extensionDecryptor) { - userLogger.warn( - "[UserBlockList] No nip04 decryptor available; treating block list as empty.", - ); - this.reset(); - this.loaded = true; - const error = new Error( - "No NIP-04 decryptor is available to load the block list.", - ); - emitStatus({ status: "error", error, decryptor: "unavailable" }); - emitStatus({ status: "settled" }); - return; - } + if (signerHasNip44) { + registerDecryptor( + "nip44", + (payload) => signer.nip44Decrypt(normalized, payload), + "active-signer", + ); + registerDecryptor( + "nip44_v2", + (payload) => signer.nip44Decrypt(normalized, payload), + "active-signer", + ); + } + + if (signerHasNip04) { + registerDecryptor( + "nip04", + (payload) => signer.nip04Decrypt(normalized, payload), + "active-signer", + ); + } + + const nostrApi = typeof window !== "undefined" ? window?.nostr : null; + if (nostrApi) { + if (typeof nostrApi.nip04?.decrypt === "function") { + registerDecryptor( + "nip04", + (payload) => nostrApi.nip04.decrypt(normalized, payload), + "extension", + ); + } + + const nip44 = + nostrApi.nip44 && typeof nostrApi.nip44 === "object" ? nostrApi.nip44 : null; + if (nip44) { + if (typeof nip44.decrypt === "function") { + registerDecryptor( + "nip44", + (payload) => nip44.decrypt(normalized, payload), + "extension", + ); + } + + const nip44v2 = nip44.v2 && typeof nip44.v2 === "object" ? nip44.v2 : null; + if (nip44v2 && typeof nip44v2.decrypt === "function") { + registerDecryptor( + "nip44_v2", + (payload) => nip44v2.decrypt(normalized, payload), + "extension", + ); + if (!decryptors.has("nip44")) { + registerDecryptor( + "nip44", + (payload) => nip44v2.decrypt(normalized, payload), + "extension", + ); + } + } + } + } + + return { + decryptors, + sources, + permissionError, + order: determineDecryptionOrder(event, Array.from(decryptors.keys())), + }; + }; try { const filter = { - kinds: [30002], + kinds: [10000, 30002], authors: [normalized], - "#d": [BLOCK_LIST_IDENTIFIER], - limit: 1, + limit: 2, }; if (since !== null) { @@ -459,7 +810,10 @@ class UserBlockListManager { settled = true; clearTimeout(timer); const events = Array.isArray(result) - ? result.filter((event) => event && event.pubkey === normalized) + ? result.filter( + (event) => + event && event.pubkey === normalized && isUserBlockListEvent(event), + ) : []; if (requireEvent && !events.length) { const emptyError = new Error( @@ -512,7 +866,10 @@ class UserBlockListManager { } const sorted = events - .filter((event) => event && event.pubkey === normalized) + .filter( + (event) => + event && event.pubkey === normalized && isUserBlockListEvent(event), + ) .sort((a, b) => (b?.created_at || 0) - (a?.created_at || 0)); if (!sorted.length) { @@ -573,36 +930,92 @@ class UserBlockListManager { return; } - let decrypted = ""; - const decryptPath = signerDecryptor - ? "active-signer" - : extensionDecryptor - ? "extension" - : "unavailable"; - try { - if (signerDecryptor) { - decrypted = await signerDecryptor(normalized, newest.content); - } else if (extensionDecryptor) { - decrypted = await extensionDecryptor(normalized, newest.content); - } else { - throw new Error("nip04-unavailable"); + const { + decryptors, + order, + sources, + permissionError, + } = await resolveDecryptors(newest); + + if (!decryptors.size) { + if (permissionError) { + userLogger.warn( + "[UserBlockList] Unable to load block list via extension decryptor; permissions denied.", + permissionError, + ); + this.reset(); + this.loaded = true; + emitStatus({ status: "error", error: permissionError, decryptor: "extension" }); + emitStatus({ status: "settled" }); + return; } - } catch (err) { + + userLogger.warn( + "[UserBlockList] No decryptors available; treating block list as empty.", + ); + this.reset(); + this.loaded = true; + const error = new Error( + "No decryptors are available to load the block list.", + ); + emitStatus({ status: "error", error, decryptor: "unavailable" }); + emitStatus({ status: "settled" }); + return; + } + + let decrypted = ""; + let schemeUsed = ""; + let schemeSource = "unavailable"; + const attemptErrors = []; + + for (const scheme of order) { + const handler = decryptors.get(scheme); + if (typeof handler !== "function") { + continue; + } + const sourceLabel = sources.get(scheme) || "unknown"; + try { + const plaintext = await handler(newest.content); + if (typeof plaintext !== "string") { + throw new Error("Decryption returned a non-string payload."); + } + decrypted = plaintext; + schemeUsed = scheme; + schemeSource = sourceLabel; + break; + } catch (error) { + attemptErrors.push({ scheme, source: sourceLabel, error }); + } + } + + if (!decrypted) { + const error = new Error( + "Failed to decrypt block list with available schemes.", + ); + error.code = "block-list-decrypt-failed"; + if (attemptErrors.length) { + error.cause = attemptErrors; + } + const lastAttempt = attemptErrors.length + ? attemptErrors[attemptErrors.length - 1] + : null; + const decryptPath = lastAttempt?.source || "unavailable"; userLogger.error( - `[UserBlockList] Failed to decrypt block list via ${decryptPath}:`, - err, + `[UserBlockList] Failed to decrypt block list via available schemes (last: ${decryptPath}).`, + error, ); applyBlockedPubkeys([], { source, reason: "decrypt-error", event: newest, - error: err, + error, decryptor: decryptPath, + errors: attemptErrors, }); emitStatus({ status: "error", event: newest, - error: err, + error, source, decryptor: decryptPath, }); @@ -610,31 +1023,21 @@ class UserBlockListManager { } try { - const parsed = JSON.parse(decrypted); - const list = Array.isArray(parsed?.blockedPubkeys) - ? parsed.blockedPubkeys - : []; - const sanitized = list - .map((entry) => normalizeHex(entry)) - .filter((candidate) => { - if (!candidate) { - return false; - } - if (candidate === normalized) { - return false; - } - return true; - }); + const sanitized = parseBlockListPlaintext(decrypted, normalized); applyBlockedPubkeys(sanitized, { source, reason: "applied", event: newest, + scheme: schemeUsed, + decryptor: schemeSource, }); emitStatus({ status: "applied", event: newest, blockedPubkeys: Array.from(this.blockedPubkeys), source, + scheme: schemeUsed, + decryptor: schemeSource, }); } catch (err) { userLogger.error("[UserBlockList] Failed to parse block list:", err); @@ -643,8 +1046,17 @@ class UserBlockListManager { reason: "parse-error", event: newest, error: err, + decryptor: schemeSource, + scheme: schemeUsed, + }); + emitStatus({ + status: "error", + event: newest, + error: err, + source, + decryptor: schemeSource, + scheme: schemeUsed, }); - emitStatus({ status: "error", event: newest, error: err, source }); } }; @@ -958,30 +1370,7 @@ class UserBlockListManager { return null; } - const tagSet = new Set(); - const tags = []; - - const iterateBlocked = (input) => { - if (Array.isArray(input)) { - return input; - } - if (input instanceof Set) { - return Array.from(input); - } - if (input && typeof input[Symbol.iterator] === "function") { - return Array.from(input); - } - return []; - }; - - for (const value of iterateBlocked(blockedPubkeys)) { - const normalized = normalizeHex(value); - if (!normalized || normalized === owner || tagSet.has(normalized)) { - continue; - } - tagSet.add(normalized); - tags.push(["p", normalized]); - } + const tags = sanitizeMuteTags(blockedPubkeys, owner); const timestamp = Number.isFinite(createdAt) ? Math.max(0, Math.floor(createdAt)) @@ -1107,14 +1496,6 @@ class UserBlockListManager { } } - if (typeof signer.nip04Encrypt !== "function") { - const err = new Error( - "NIP-04 encryption is required to update the block list." - ); - err.code = "nip04-missing"; - throw err; - } - if (typeof signer.signEvent !== "function") { const err = new Error("Active signer missing signEvent support."); err.code = "sign-event-missing"; @@ -1126,26 +1507,82 @@ class UserBlockListManager { throw new Error("Invalid user pubkey."); } + const sanitizedTags = sanitizeMuteTags(this.blockedPubkeys, normalized); const payload = { - blockedPubkeys: Array.from(this.blockedPubkeys).filter( - (candidate) => candidate && candidate !== normalized - ), + blockedPubkeys: sanitizedTags.map(([, target]) => target), }; - const plaintext = JSON.stringify(payload); + const plaintext = serializeBlockListTagMatrix(sanitizedTags, normalized, { + logDiscarded: false, + }); - let cipherText = ""; - try { - cipherText = await signer.nip04Encrypt(normalized, plaintext); - } catch (error) { - const err = new Error("Failed to encrypt block list."); - err.code = "nip04-missing"; + const encryptors = []; + const registerEncryptor = (scheme, handler) => { + if (!scheme || typeof handler !== "function") { + return; + } + encryptors.push({ scheme, handler }); + }; + + if (typeof signer.nip44Encrypt === "function") { + registerEncryptor("nip44_v2", (value) => signer.nip44Encrypt(normalized, value)); + registerEncryptor("nip44", (value) => signer.nip44Encrypt(normalized, value)); + } + + if (typeof signer.nip04Encrypt === "function") { + registerEncryptor("nip04", (value) => signer.nip04Encrypt(normalized, value)); + } + + if (!encryptors.length) { + const err = new Error( + "An encryption-capable signer is required to update the block list." + ); + err.code = "block-list-missing-encryptor"; throw err; } + let cipherText = ""; + let encryptionScheme = ""; + const seenSchemes = new Set(); + const encryptionErrors = []; + + for (const candidate of encryptors) { + if (seenSchemes.has(candidate.scheme)) { + continue; + } + seenSchemes.add(candidate.scheme); + try { + const encrypted = await candidate.handler(plaintext); + if (typeof encrypted === "string" && encrypted) { + cipherText = encrypted; + encryptionScheme = candidate.scheme; + break; + } + } catch (error) { + encryptionErrors.push({ scheme: candidate.scheme, error }); + } + } + + if (!cipherText) { + const err = new Error("Failed to encrypt block list."); + err.code = "block-list-encrypt-failed"; + err.cause = encryptionErrors; + throw err; + } + + const encryptionTagValue = + encryptionScheme === "nip44_v2" + ? "nip44_v2" + : encryptionScheme === "nip44" + ? "nip44" + : encryptionScheme === "nip04" + ? "nip04" + : undefined; + const event = buildBlockListEvent({ pubkey: normalized, created_at: Math.floor(Date.now() / 1000), content: cipherText, + encryption: encryptionTagValue, }); const signedEvent = await signer.signEvent(event); diff --git a/js/utils/videoPointer.js b/js/utils/videoPointer.js index 9dd6b5b9..292ef31d 100644 --- a/js/utils/videoPointer.js +++ b/js/utils/videoPointer.js @@ -42,7 +42,18 @@ export function resolveVideoPointer({ for (const pointer of pointerCandidates) { const key = pointerArrayToKey(pointer); if (key) { - return { pointer, key }; + const pointerEventId = + pointer[0] === "e" && typeof pointer[1] === "string" + ? pointer[1].trim() + : fallbackId; + return { + pointer, + key, + eventId: + typeof pointerEventId === "string" && pointerEventId + ? pointerEventId + : "", + }; } } diff --git a/package.json b/package.json index 8d2c70b3..a02e4a8b 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "type": "module", "version": "1.0.0", "scripts": { + "build": "npm run build:css", "build:css": "npx tailwindcss -c tailwind.config.cjs -i css/tailwind.source.css -o css/tailwind.generated.css --minify", "build:beacon:bundle": "node scripts/build-beacon.mjs", "build:beacon": "npm run build:beacon:bundle && npm run lint:inline-styles", @@ -16,9 +17,9 @@ "lint:tokens": "node scripts/check-design-tokens.mjs --check=tokens", "lint:tailwind-brackets": "node scripts/check-design-tokens.mjs --check=brackets", "lint:tailwind-colors": "node scripts/check-tailwind-colors.mjs", - "check:css": "npm run build:css && git diff --exit-code -- css/tailwind.generated.css", - "test:visual": "npm run build:css && npx playwright test", - "test:visual:update": "npm run build:css && cross-env UPDATE_VISUAL_BASELINES=1 npx playwright test", + "check:css": "npm run build:css", + "test:visual": "npm run build && npx playwright test", + "test:visual:update": "npm run build && cross-env UPDATE_VISUAL_BASELINES=1 npx playwright test", "test:unit": "node scripts/run-unit-tests.mjs" }, "devDependencies": { diff --git a/tests/app/hydrate-sidebar-navigation.test.mjs b/tests/app/hydrate-sidebar-navigation.test.mjs new file mode 100644 index 00000000..139e7e51 --- /dev/null +++ b/tests/app/hydrate-sidebar-navigation.test.mjs @@ -0,0 +1,96 @@ +import test from "node:test"; +import assert from "node:assert/strict"; +import { JSDOM } from "jsdom"; + +import { Application } from "../../js/app.js"; + +const VIEW_HTML = `<!DOCTYPE html> +<html> + <body> + <div id="chrome"> + <button id="loginButton" class="btn"></button> + <button id="logoutButton" class="hidden"></button> + <button id="uploadButton" class="hidden" hidden></button> + <button id="profileButton" class="hidden" hidden></button> + <span id="userStatus" class="hidden"></span> + <span id="userPubKey"></span> + <button id="closeLoginModal"></button> + </div> + <a id="subscriptionsLink" class="hidden"></a> + </body> +</html>`; + +test("hydrateSidebarNavigation reveals chrome controls for authenticated viewers", () => { + const dom = new JSDOM(VIEW_HTML, { url: "https://example.com" }); + const { window } = dom; + + const previousWindow = global.window; + const previousDocument = global.document; + + global.window = window; + global.document = window.document; + const previousHTMLElement = global.HTMLElement; + global.HTMLElement = window.HTMLElement; + + try { + const app = Object.create(Application.prototype); + + app.appChromeController = { + receivedElements: null, + setElements(elements) { + this.receivedElements = elements; + }, + }; + + app.userStatus = window.document.getElementById("userStatus"); + app.userPubKey = window.document.getElementById("userPubKey"); + app.subscriptionsLink = null; + app.isUserLoggedIn = () => true; + app.log = () => {}; + app.showError = () => {}; + app.showSuccess = () => {}; + app.showStatus = () => {}; + + app.hydrateSidebarNavigation(); + + const uploadButton = window.document.getElementById("uploadButton"); + const profileButton = window.document.getElementById("profileButton"); + const loginButton = window.document.getElementById("loginButton"); + const logoutButton = window.document.getElementById("logoutButton"); + const subscriptionsLink = window.document.getElementById("subscriptionsLink"); + const closeLoginButton = window.document.getElementById("closeLoginModal"); + + assert.equal(app.uploadButton, uploadButton); + assert.equal(app.profileButton, profileButton); + assert.equal(app.loginButton, loginButton); + assert.equal(app.logoutButton, logoutButton); + assert.equal(app.closeLoginModalBtn, closeLoginButton); + + assert.equal(uploadButton.classList.contains("hidden"), false); + assert.equal(uploadButton.hasAttribute("hidden"), false); + assert.equal(profileButton.classList.contains("hidden"), false); + assert.equal(profileButton.hasAttribute("hidden"), false); + assert.equal(loginButton.classList.contains("hidden"), true); + assert.equal(loginButton.hasAttribute("hidden"), true); + assert.equal(logoutButton.classList.contains("hidden"), false); + assert.equal(subscriptionsLink.classList.contains("hidden"), false); + + assert.ok(app.appChromeController.receivedElements); + assert.equal( + app.appChromeController.receivedElements.uploadButton, + uploadButton, + ); + assert.equal( + app.appChromeController.receivedElements.profileButton, + profileButton, + ); + } finally { + global.window = previousWindow; + global.document = previousDocument; + if (previousHTMLElement === undefined) { + delete global.HTMLElement; + } else { + global.HTMLElement = previousHTMLElement; + } + } +}); diff --git a/tests/app/is-user-logged-in.test.mjs b/tests/app/is-user-logged-in.test.mjs new file mode 100644 index 00000000..84d503d6 --- /dev/null +++ b/tests/app/is-user-logged-in.test.mjs @@ -0,0 +1,132 @@ +import test from "node:test"; +import assert from "node:assert/strict"; + +import { Application } from "../../js/app.js"; +import { nostrClient } from "../../js/nostrClientFacade.js"; + +const HEX64_REGEX = /^[0-9a-f]{64}$/i; + +function createTestApp(pubkey) { + const app = { + _pubkey: pubkey, + normalizeHexPubkey(value) { + if (typeof value !== "string") { + return null; + } + + const trimmed = value.trim(); + if (!trimmed) { + return null; + } + + if (HEX64_REGEX.test(trimmed)) { + return trimmed.toLowerCase(); + } + + return null; + }, + isUserLoggedIn: Application.prototype.isUserLoggedIn, + }; + + Object.defineProperty(app, "pubkey", { + get() { + return this._pubkey; + }, + set(value) { + this._pubkey = value; + }, + }); + + return app; +} + +test("isUserLoggedIn returns false when no user pubkey is set", () => { + const previousPubkey = nostrClient.pubkey; + const previousSessionActor = nostrClient.sessionActor; + + try { + nostrClient.pubkey = null; + nostrClient.sessionActor = null; + + const app = createTestApp(null); + assert.equal(app.isUserLoggedIn(), false); + } finally { + nostrClient.pubkey = previousPubkey; + nostrClient.sessionActor = previousSessionActor; + } +}); + +test("isUserLoggedIn treats extension logins as authenticated", () => { + const previousPubkey = nostrClient.pubkey; + const previousSessionActor = nostrClient.sessionActor; + + try { + const pubkey = "893a31fa5a6481295bb76ea2dd8d5ec70640e6e6ad398e6547d771e8256af11f"; + nostrClient.pubkey = pubkey; + nostrClient.sessionActor = { pubkey }; + + const app = createTestApp(pubkey); + assert.equal(app.isUserLoggedIn(), true); + } finally { + nostrClient.pubkey = previousPubkey; + nostrClient.sessionActor = previousSessionActor; + } +}); + +test("isUserLoggedIn guards against mismatched nostrClient state", () => { + const previousPubkey = nostrClient.pubkey; + const previousSessionActor = nostrClient.sessionActor; + + try { + const pubkey = "a".repeat(64); + nostrClient.pubkey = "b".repeat(64); + nostrClient.sessionActor = { pubkey }; + + const app = createTestApp(pubkey); + assert.equal(app.isUserLoggedIn(), false); + } finally { + nostrClient.pubkey = previousPubkey; + nostrClient.sessionActor = previousSessionActor; + } +}); + +test("isUserLoggedIn ignores anonymous session actor mismatches", () => { + const previousPubkey = nostrClient.pubkey; + const previousSessionActor = nostrClient.sessionActor; + + try { + const pubkey = "c".repeat(64); + nostrClient.pubkey = pubkey; + nostrClient.sessionActor = { + pubkey: "d".repeat(64), + privateKey: "e".repeat(64), + createdAt: Date.now(), + }; + + const app = createTestApp(pubkey); + assert.equal(app.isUserLoggedIn(), true); + } finally { + nostrClient.pubkey = previousPubkey; + nostrClient.sessionActor = previousSessionActor; + } +}); + +test("isUserLoggedIn rejects mismatched managed session actors", () => { + const previousPubkey = nostrClient.pubkey; + const previousSessionActor = nostrClient.sessionActor; + + try { + const pubkey = "f".repeat(64); + nostrClient.pubkey = pubkey; + nostrClient.sessionActor = { + pubkey: "0".repeat(64), + source: "nsec", + }; + + const app = createTestApp(pubkey); + assert.equal(app.isUserLoggedIn(), false); + } finally { + nostrClient.pubkey = previousPubkey; + nostrClient.sessionActor = previousSessionActor; + } +}); diff --git a/tests/comment-event-builder.test.mjs b/tests/comment-event-builder.test.mjs index 436bbcf5..b1f80962 100644 --- a/tests/comment-event-builder.test.mjs +++ b/tests/comment-event-builder.test.mjs @@ -1,34 +1,62 @@ import test from "node:test"; import assert from "node:assert/strict"; -import { buildCommentEvent } from "../js/nostrEventSchemas.js"; +const SANITIZED_SAMPLE_HEX = "deadbeef".repeat(8); +const SANITIZED_SAMPLE_NPUB = "npub1commentadditionaltagfixture000000000000000000000"; -test("buildCommentEvent produces required tags for top-level comments", () => { +if (typeof globalThis.window === "undefined") { + globalThis.window = {}; +} + +if (!globalThis.window.NostrTools) { + globalThis.window.NostrTools = {}; +} + +const existingNip19 = + typeof globalThis.window.NostrTools.nip19 === "object" + ? globalThis.window.NostrTools.nip19 + : {}; + +if (typeof existingNip19.decode !== "function") { + globalThis.window.NostrTools.nip19 = { + ...existingNip19, + decode: (value) => ({ type: "npub", data: SANITIZED_SAMPLE_HEX }), + }; +} + +const { + buildCommentEvent, + getNostrEventSchema, + NOTE_TYPES, +} = await import("../js/nostrEventSchemas.js"); + +const VIDEO_COMMENT_KIND = + getNostrEventSchema(NOTE_TYPES.VIDEO_COMMENT)?.kind ?? 1111; + +test("buildCommentEvent emits NIP-22 root metadata while keeping legacy fallbacks", () => { const event = buildCommentEvent({ pubkey: "commenter", created_at: 1700000200, videoEventId: "video-event-id", - videoEventRelay: "wss://relay.example", videoDefinitionAddress: "30078:deadbeefcafebabe:clip-1", threadParticipantPubkey: "deadbeefcafebabe", content: "Great \ud800video!", }); - assert.equal(event.kind, 1); - - const eventTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "e"); - assert.deepEqual(eventTags, [["e", "video-event-id", "wss://relay.example"]]); - - const addressTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "a"); - assert.deepEqual(addressTags, [["a", "30078:deadbeefcafebabe:clip-1"]]); - - const participantTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "p"); - assert.deepEqual(participantTags, [["p", "deadbeefcafebabe"]]); - + assert.equal(event.kind, VIDEO_COMMENT_KIND); + assert.deepStrictEqual(event.tags, [ + ["A", "30078:deadbeefcafebabe:clip-1"], + ["K", "30078"], + ["P", "deadbeefcafebabe"], + ["e", "video-event-id"], + ["a", "30078:deadbeefcafebabe:clip-1"], + ["k", "30078"], + ["p", "deadbeefcafebabe"], + ]); assert.equal(event.content, "Great video!"); }); -test("buildCommentEvent includes parent pointers for threaded replies", () => { +test("buildCommentEvent includes parent pointers, kinds, and authors for replies", () => { const event = buildCommentEvent({ pubkey: "commenter", created_at: 1700000201, @@ -39,22 +67,20 @@ test("buildCommentEvent includes parent pointers for threaded replies", () => { content: "Replying now", }); - assert.equal(event.kind, 1); - - const eventTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "e"); - assert.deepEqual(eventTags, [ + assert.equal(event.kind, VIDEO_COMMENT_KIND); + assert.deepStrictEqual(event.tags, [ + ["A", "30078:deadbeefcafebabe:clip-1"], + ["K", "30078"], + ["P", "deadbeefcafebabe"], ["e", "video-event-id"], - ["e", "parent-comment-id"], + ["a", "30078:deadbeefcafebabe:clip-1"], + ["e", "parent-comment-id", "parent-author"], + ["k", String(VIDEO_COMMENT_KIND)], + ["p", "parent-author"], ]); - - const addressTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "a"); - assert.deepEqual(addressTags, [["a", "30078:deadbeefcafebabe:clip-1"]]); - - const participantTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "p"); - assert.deepEqual(participantTags, [["p", "parent-author"]]); }); -test("buildCommentEvent normalizes optional relays and preserves additional tags", () => { +test("buildCommentEvent normalizes relays and preserves explicit overrides", () => { const event = buildCommentEvent({ pubkey: "author", created_at: 1700000300, @@ -70,14 +96,106 @@ test("buildCommentEvent normalizes optional relays and preserves additional tags content: " Appreciated! \ud800", }); - assert.equal(event.kind, 1); + assert.equal(event.kind, VIDEO_COMMENT_KIND); assert.deepStrictEqual(event.tags, [ + ["A", "30078:deadbeefcafebabe:clip-2", "wss://video.def"], + ["K", "30078"], + ["P", "deadbeefcafebabe", "wss://video.def"], ["e", "event123", "wss://comments.main"], ["a", "30078:deadbeefcafebabe:clip-2", "wss://video.def"], - ["e", "root-comment", "wss://parent"], + ["e", "root-comment", "wss://parent", "cafecafe"], + ["k", String(VIDEO_COMMENT_KIND)], ["p", "cafecafe", "wss://profile"], ["client", "bitvid"], - ["p", "cafecafe", "wss://override"], ]); assert.equal(event.content, " Appreciated! "); }); + +test("buildCommentEvent falls back to event pointers when no address is supplied", () => { + const event = buildCommentEvent({ + pubkey: "commenter", + created_at: 1700000400, + videoEventId: "legacy-event", + videoEventRelay: "wss://legacy.example", + threadParticipantPubkey: "legacy-pubkey", + rootKind: "1063", + rootAuthorPubkey: "legacy-author", + content: "Legacy thread support", + }); + + assert.equal(event.kind, VIDEO_COMMENT_KIND); + assert.deepStrictEqual(event.tags, [ + ["E", "legacy-event", "wss://legacy.example", "legacy-author"], + ["K", "1063"], + ["P", "legacy-author"], + ["e", "legacy-event", "wss://legacy.example"], + ["k", "1063"], + ["p", "legacy-pubkey"], + ]); +}); + +test("buildCommentEvent accepts partial metadata for parent overrides", () => { + const event = buildCommentEvent({ + pubkey: "reply-author", + created_at: 1700000500, + videoEventId: "file-event", + rootKind: "1063", + parentCommentId: "parent-comment", + parentCommentRelay: "wss://parent", + parentKind: "1111", + parentAuthorPubkey: "parent-only", + parentAuthorRelay: "wss://parent-author", + content: "Reply with sparse data", + }); + + assert.equal(event.kind, VIDEO_COMMENT_KIND); + assert.deepStrictEqual(event.tags, [ + ["E", "file-event"], + ["K", "1063"], + ["e", "file-event"], + ["e", "parent-comment", "wss://parent", "parent-only"], + ["k", "1111"], + ["p", "parent-only", "wss://parent-author"], + ]); +}); + +test("buildCommentEvent sanitizes additional tags before signing", () => { + const event = buildCommentEvent({ + pubkey: "sanitizer", + created_at: 1700000600, + videoEventId: "sanitized-event", + threadParticipantPubkey: "cafecafe", + additionalTags: [ + ["p", null], + ["p", SANITIZED_SAMPLE_NPUB], + ["client", { foo: "bar" }], + ["client", "bitvid"], + ], + content: "sanitize", + }); + + const clientTags = event.tags.filter( + (tag) => Array.isArray(tag) && tag[0] === "client", + ); + assert.deepStrictEqual(clientTags, [["client", "bitvid"]]); + + const normalizedAdditionalPubkeys = event.tags.filter( + (tag) => Array.isArray(tag) && tag[0] === "p" && tag[1] === SANITIZED_SAMPLE_HEX, + ); + assert.equal( + normalizedAdditionalPubkeys.length, + 1, + "sanitized npub additional tag should normalize to hex", + ); + + assert.ok( + !event.tags.some( + (tag) => + Array.isArray(tag) && + tag[0] === "client" && + typeof tag[1] === "string" && + tag[1].includes("[object Object]"), + ), + "invalid object values should be removed instead of stringified", + ); +}); diff --git a/tests/comment-thread-service.test.mjs b/tests/comment-thread-service.test.mjs index aa1fb3e1..6efa2caf 100644 --- a/tests/comment-thread-service.test.mjs +++ b/tests/comment-thread-service.test.mjs @@ -2,6 +2,8 @@ import test from "node:test"; import assert from "node:assert/strict"; import CommentThreadService from "../js/services/commentThreadService.js"; +import { listVideoComments } from "../js/nostr/commentEvents.js"; +import { buildCommentEvent } from "../js/nostrEventSchemas.js"; function createBaseVideo() { return { @@ -35,6 +37,179 @@ function createComment({ const tick = (ms = 0) => new Promise((resolve) => setTimeout(resolve, ms)); +const originalLocalStorage = globalThis.localStorage; +const originalWindowLocalStorage = globalThis.window?.localStorage; + +function createIsolatedLocalStorage() { + const store = new Map(); + return { + getItem(key) { + return store.has(key) ? store.get(key) : null; + }, + setItem(key, value) { + store.set(String(key), String(value)); + }, + removeItem(key) { + store.delete(String(key)); + }, + clear() { + store.clear(); + }, + key(index) { + return Array.from(store.keys())[index] ?? null; + }, + get length() { + return store.size; + }, + }; +} + +test.beforeEach(() => { + const stub = createIsolatedLocalStorage(); + globalThis.localStorage = stub; + if (globalThis.window) { + globalThis.window.localStorage = stub; + } +}); + +test.after(() => { + if (originalLocalStorage) { + globalThis.localStorage = originalLocalStorage; + } else { + delete globalThis.localStorage; + } + if (globalThis.window) { + if (originalWindowLocalStorage) { + globalThis.window.localStorage = originalWindowLocalStorage; + } else { + delete globalThis.window.localStorage; + } + } +}); + +test( + "listVideoComments accepts builder events without parent ids and filters replies", + async () => { + const relayUrl = "wss://relay.example"; + const videoEventId = "video123"; + const videoDefinitionAddress = "30078:authorpk:video-root"; + const topLevelCommentId = "comment-root"; + const replyCommentId = "comment-reply"; + + const topLevelEvent = { + id: topLevelCommentId, + ...buildCommentEvent({ + pubkey: "commenterpk", + created_at: 1700000000, + videoEventId, + videoEventRelay: relayUrl, + videoDefinitionAddress, + videoDefinitionRelay: relayUrl, + rootIdentifier: "video-root", + rootIdentifierRelay: relayUrl, + rootKind: "30078", + rootAuthorPubkey: "authorpk", + }), + }; + + assert.ok( + topLevelEvent.tags.some( + (tag) => + Array.isArray(tag) && + tag[0] === "e" && + tag[1] === videoEventId && + tag[2] === relayUrl, + ), + "builder should retain legacy #e tag for the root event when address pointer is present", + ); + assert.ok( + topLevelEvent.tags.some( + (tag) => + Array.isArray(tag) && tag[0] === "a" && tag[1] === videoDefinitionAddress, + ), + "builder should include #a pointer for the scoped video definition", + ); + + const replyEvent = { + id: replyCommentId, + ...buildCommentEvent({ + pubkey: "replypk", + created_at: 1700000300, + videoEventId, + videoEventRelay: relayUrl, + videoDefinitionAddress, + videoDefinitionRelay: relayUrl, + rootIdentifier: "video-root", + rootIdentifierRelay: relayUrl, + rootKind: "30078", + rootAuthorPubkey: "authorpk", + parentCommentId: topLevelCommentId, + parentCommentRelay: relayUrl, + parentAuthorPubkey: "commenterpk", + }), + }; + + assert.ok( + replyEvent.tags.some( + (tag) => + Array.isArray(tag) && + tag[0] === "e" && + tag[1] === videoEventId && + tag[2] === relayUrl, + ), + "reply builder should include root #e tag alongside #a pointer", + ); + assert.ok( + replyEvent.tags.some( + (tag) => + Array.isArray(tag) && tag[0] === "a" && tag[1] === videoDefinitionAddress, + ), + "reply builder should preserve #a pointer", + ); + + const listCalls = []; + const client = { + relays: [relayUrl], + pool: { + list: async (relays, filters) => { + listCalls.push({ relays, filters }); + return [[topLevelEvent, replyEvent]]; + }, + }, + }; + + const baseTarget = { + videoEventId, + videoDefinitionAddress, + videoEventRelay: relayUrl, + videoDefinitionRelay: relayUrl, + rootIdentifier: "video-root", + }; + + const topLevelResults = await listVideoComments(client, baseTarget, { + relays: [relayUrl], + }); + assert.equal( + topLevelResults.some((event) => event.id === topLevelCommentId), + true, + "top-level builder comment should be returned when no parent is specified", + ); + + const replyResults = await listVideoComments( + client, + { ...baseTarget, parentCommentId: topLevelCommentId }, + { relays: [relayUrl] }, + ); + assert.deepStrictEqual( + replyResults.map((event) => event.id), + [replyCommentId], + "reply queries should filter to child events when parent id is provided", + ); + + assert.equal(listCalls.length, 2, "pool.list should be invoked for each query"); + }, +); + test( "CommentThreadService hydrates, subscribes, and dedupes incoming comment events", async (t) => { @@ -113,12 +288,13 @@ test( assert.deepStrictEqual(lastFetchTarget, { videoEventId: "video123", videoDefinitionAddress: "30078:authorpk:video-root", + videoKind: "30078", + videoAuthorPubkey: "authorpk", parentCommentId: "", }); - assert.deepStrictEqual(lastFetchOptions, { - limit: service.defaultLimit, - relays: ["wss://relay.example"], - }); + assert.equal(lastFetchOptions.limit, service.defaultLimit); + assert.deepStrictEqual(lastFetchOptions.relays, ["wss://relay.example"]); + assert.equal(lastFetchOptions.since, 0); assert.equal(subscribeCalls, 1, "subscribeVideoComments should be invoked"); assert.deepStrictEqual(subscriptionTarget, lastFetchTarget); @@ -129,6 +305,11 @@ test( const initialSnapshot = initialPayloads[0]; assert.ok(initialSnapshot.childrenByParent instanceof Map); + assert.equal(initialSnapshot.videoDefinitionAddress, "30078:authorpk:video-root"); + assert.equal(initialSnapshot.videoKind, "30078"); + assert.equal(initialSnapshot.videoAuthorPubkey, "authorpk"); + assert.equal(initialSnapshot.parentCommentKind, null); + assert.equal(initialSnapshot.parentCommentPubkey, null); assert.deepStrictEqual(initialSnapshot.topLevelIds, [ "comment-2", "comment-1", @@ -205,6 +386,164 @@ test( }, ); +test( + "CommentThreadService loadThread falls back to event id when address is missing", + async () => { + const video = { + ...createBaseVideo(), + tags: [["alt", "ignored"]], + }; + + const fetchTargets = []; + const fetchOptions = []; + const subscribeTargets = []; + const subscribeOptions = []; + const errors = []; + + const service = new CommentThreadService({ + fetchVideoComments: async (target, options) => { + fetchTargets.push(target); + fetchOptions.push(options); + return []; + }, + subscribeVideoComments: (target, options = {}) => { + subscribeTargets.push(target); + subscribeOptions.push(options); + return () => {}; + }, + }); + + service.setCallbacks({ + onError: (error) => errors.push(error), + }); + + const snapshot = await service.loadThread({ video }); + + assert.equal(fetchTargets.length, 1, "fetch should run even without an address"); + assert.deepStrictEqual(fetchTargets[0], { + videoEventId: "video123", + videoKind: "30078", + videoAuthorPubkey: "authorpk", + parentCommentId: "", + }); + assert.equal( + "videoDefinitionAddress" in fetchTargets[0], + false, + "videoDefinitionAddress should be omitted when unavailable", + ); + + const [firstFetchOptions] = fetchOptions; + assert.equal(firstFetchOptions.limit, service.defaultLimit); + assert.equal(firstFetchOptions.relays, null); + assert.equal(firstFetchOptions.since, 0); + + assert.equal( + subscribeTargets.length, + 1, + "subscribe should run even without an address", + ); + assert.deepStrictEqual(subscribeTargets[0], fetchTargets[0]); + assert.equal( + typeof subscribeOptions[0]?.onEvent, + "function", + "subscription handler should be provided", + ); + + assert.equal(errors.length, 0, "missing address should not emit errors"); + assert.equal(snapshot.videoEventId, "video123"); + assert.equal(snapshot.videoKind, "30078"); + assert.equal(snapshot.videoAuthorPubkey, "authorpk"); + assert.equal(snapshot.videoDefinitionAddress, null); + }, +); + +test( + "CommentThreadService preserves raw video author pubkeys during hydration fetches", + async () => { + const video = { + id: "video-upper", + pubkey: "AUTHORPK", + kind: 30078, + tags: [["d", "video-root-upper"]], + }; + + const videoDefinitionAddress = "30078:AUTHORPK:video-root-upper"; + const pendingComment = { + id: "upper-comment-1", + ...buildCommentEvent({ + pubkey: "commenter-upper", + created_at: 1700001200, + videoEventId: video.id, + videoDefinitionAddress, + rootIdentifier: "video-root-upper", + rootKind: "30078", + rootAuthorPubkey: video.pubkey, + content: "Uppercase hydration check", + }), + }; + + const fetchTargets = []; + let resolveFetch = () => {}; + const fetchBlocker = new Promise((resolve) => { + resolveFetch = resolve; + }); + const fetchVideoComments = async (target) => { + fetchTargets.push(target); + await fetchBlocker; + if (target.videoAuthorPubkey === video.pubkey) { + return [pendingComment]; + } + return []; + }; + + const subscribeTargets = []; + const service = new CommentThreadService({ + fetchVideoComments, + subscribeVideoComments: (target, _options = {}) => { + subscribeTargets.push(target); + return () => {}; + }, + hydrationDebounceMs: 0, + }); + + const loadPromise = service.loadThread({ video }); + await tick(); + + assert.equal(fetchTargets.length, 1, "hydration fetch should start immediately"); + + service.processIncomingEvent(pendingComment); + resolveFetch(); + + const snapshot = await loadPromise; + + assert.equal( + fetchTargets[0].videoAuthorPubkey, + video.pubkey, + "fetch target should prefer the raw video author pubkey", + ); + assert.equal( + snapshot.videoAuthorPubkey, + video.pubkey, + "snapshot should retain the raw video author pubkey", + ); + assert.equal( + snapshot.commentsById.has(pendingComment.id), + true, + "hydration should include comments published before fetch completion", + ); + assert.equal( + subscribeTargets.length, + 1, + "subscription should begin after hydration completes", + ); + assert.equal( + subscribeTargets[0].videoAuthorPubkey, + video.pubkey, + "subscription target should also retain the raw pubkey", + ); + }, +); + test( "CommentThreadService teardown cancels hydration timers", async () => { diff --git a/tests/discussion-count-service.test.mjs b/tests/discussion-count-service.test.mjs index 75652af2..8f94dbd0 100644 --- a/tests/discussion-count-service.test.mjs +++ b/tests/discussion-count-service.test.mjs @@ -6,6 +6,7 @@ import { JSDOM } from "jsdom"; import DiscussionCountService, { COUNT_UNSUPPORTED_TITLE, } from "../js/services/discussionCountService.js"; +import { COMMENT_EVENT_KIND } from "../js/nostr/commentEvents.js"; function createDomWithCountElement(videoId) { const dom = new JSDOM(` @@ -35,7 +36,22 @@ async function testRefreshCountsCachesResults() { const nostrClient = { pool: {}, countEventsAcrossRelays: async (filters) => { - assert.equal(filters.length, 2, "should request both id and address filters"); + assert.equal(filters.length, 3, "should request id, uppercase, and address filters"); + const [eventFilter, uppercaseFilter, addressFilter] = filters; + assert.deepEqual(eventFilter, { + kinds: [COMMENT_EVENT_KIND], + "#e": ["count-video-1"], + }); + assert.deepEqual(uppercaseFilter, { + kinds: [COMMENT_EVENT_KIND], + "#A": ["30078:pubkey-1:identifier-1"], + "#K": ["30078"], + "#P": ["pubkey-1"], + }); + assert.deepEqual(addressFilter, { + kinds: [COMMENT_EVENT_KIND], + "#a": ["30078:pubkey-1:identifier-1"], + }); return { total: 5, perRelay: [{ ok: true }], @@ -102,10 +118,28 @@ async function testUnsupportedRelaysUpdateDomState() { const service = new DiscussionCountService(); const nostrClient = { pool: {}, - countEventsAcrossRelays: async () => ({ - total: 7, - perRelay: [{ ok: false }], - }), + countEventsAcrossRelays: async (filters) => { + assert.equal(filters.length, 3, "unsupported relays should still receive all filters"); + const [eventFilter, uppercaseFilter, addressFilter] = filters; + assert.deepEqual(eventFilter, { + kinds: [COMMENT_EVENT_KIND], + "#e": ["unsupported-video"], + }); + assert.deepEqual(uppercaseFilter, { + kinds: [COMMENT_EVENT_KIND], + "#A": ["30078:pubkey-2:identifier-2"], + "#K": ["30078"], + "#P": ["pubkey-2"], + }); + assert.deepEqual(addressFilter, { + kinds: [COMMENT_EVENT_KIND], + "#a": ["30078:pubkey-2:identifier-2"], + }); + return { + total: 7, + perRelay: [{ ok: false }], + }; + }, }; service.refreshCounts([video], { diff --git a/tests/edit-modal-submit-state.test.mjs b/tests/edit-modal-submit-state.test.mjs index 97f3d7fd..56d4ecfc 100644 --- a/tests/edit-modal-submit-state.test.mjs +++ b/tests/edit-modal-submit-state.test.mjs @@ -192,6 +192,86 @@ test('ignores additional submissions while pending without spurious errors', asy modal.setSubmitState({ pending: false }); }); +test('editing the magnet refreshes torrent hints when ws/xs remain locked', async () => { + const modal = createModal(); + await modal.load({ container }); + + const originalMagnet = + 'magnet:?xt=urn:btih:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ws=https://old.example/video.mp4&xs=https://old.example/video.torrent'; + const video = { + id: 'video-magnet-locked', + pubkey: 'pubkey-magnet-locked', + title: 'Locked hints example', + url: 'https://example.com/locked.mp4', + magnet: originalMagnet, + ws: 'https://old.example/video.mp4', + xs: 'https://old.example/video.torrent', + }; + + await modal.open(video); + + const submissions = []; + modal.addEventListener('video:edit-submit', (event) => { + submissions.push(event.detail); + }); + + const magnetButton = modal.root.querySelector( + '[data-edit-target="editVideoMagnet"]', + ); + assert.ok(magnetButton, 'expected magnet unlock button to exist'); + magnetButton.dispatchEvent(new dom.window.Event('click', { bubbles: true })); + + const magnetInput = modal.fields.magnet; + assert.ok(magnetInput, 'expected magnet input to exist'); + magnetInput.value = + 'magnet:?xt=urn:btih:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb&ws=https://new.example/video.mp4&xs=https://new.example/video.torrent'; + + modal.submit(); + + assert.equal(submissions.length, 1, 'should emit a single submission payload'); + const submission = submissions[0]; + assert.ok(submission, 'expected edit submission detail'); + + assert.equal( + submission.updatedData.wsEdited, + true, + 'ws should be marked as edited when magnet changes', + ); + assert.equal( + submission.updatedData.xsEdited, + true, + 'xs should be marked as edited when magnet changes', + ); + assert.equal( + submission.updatedData.ws, + 'https://new.example/video.mp4', + 'ws hint should refresh to the new magnet hint', + ); + assert.equal( + submission.updatedData.xs, + 'https://new.example/video.torrent', + 'xs hint should refresh to the new magnet hint', + ); + assert.ok( + submission.updatedData.magnet.includes( + 'urn:btih:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', + ), + 'normalized magnet should contain the updated info hash', + ); + assert.ok( + submission.updatedData.magnet.includes('ws=https://new.example/video.mp4'), + 'normalized magnet should include the refreshed ws hint', + ); + assert.ok( + submission.updatedData.magnet.includes( + 'xs=https://new.example/video.torrent', + ), + 'normalized magnet should include the refreshed xs hint', + ); + + modal.setSubmitState({ pending: false }); +}); + test('does not show missing video error after modal closes', async () => { const errorMessages = []; const modal = createModal({ diff --git a/tests/helpers/moderation-test-helpers.mjs b/tests/helpers/moderation-test-helpers.mjs index a03e6f0b..3d1a8f87 100644 --- a/tests/helpers/moderation-test-helpers.mjs +++ b/tests/helpers/moderation-test-helpers.mjs @@ -3,6 +3,7 @@ import { ModerationService } from "../../js/services/moderationService.js"; import { getDefaultModerationSettings } from "../../js/state/cache.js"; const DEFAULT_CONTACT_OWNER = "f".repeat(64); +const DEFAULT_REPORT_TARGET = "e".repeat(64); export function withMockedNostrTools(t) { const hadWindow = typeof globalThis.window !== "undefined"; @@ -99,6 +100,8 @@ export function createReportEvent({ id, reporter, eventId, + targetPubkey = DEFAULT_REPORT_TARGET, + relayHint = "", createdAt = Math.floor(Date.now() / 1000), type = "nudity", } = {}) { @@ -108,7 +111,19 @@ export function createReportEvent({ : `${Math.random().toString(16).slice(2)}${"0".repeat(64)}`.slice(0, 64); const reporterPubkey = typeof reporter === "string" && reporter ? reporter : ""; const targetEventId = typeof eventId === "string" && eventId ? eventId : ""; + const targetAuthor = + typeof targetPubkey === "string" && targetPubkey + ? targetPubkey + : DEFAULT_REPORT_TARGET; const normalizedType = typeof type === "string" && type ? type : "nudity"; + const normalizedRelayHint = + typeof relayHint === "string" && relayHint ? relayHint : ""; + + const eventTag = ["e", targetEventId]; + if (normalizedRelayHint) { + eventTag.push(normalizedRelayHint); + } + eventTag.push(normalizedType); return { kind: 1984, @@ -116,8 +131,9 @@ export function createReportEvent({ pubkey: reporterPubkey, created_at: Number.isFinite(createdAt) ? Math.floor(createdAt) : Math.floor(Date.now() / 1000), tags: [ - ["e", targetEventId], - ["report", normalizedType], + eventTag, + ["p", targetAuthor, normalizedType], + ["t", normalizedType], ], content: "fixture report", }; diff --git a/tests/moderation/submit-report.test.mjs b/tests/moderation/submit-report.test.mjs new file mode 100644 index 00000000..560b4a96 --- /dev/null +++ b/tests/moderation/submit-report.test.mjs @@ -0,0 +1,99 @@ +import test from "node:test"; +import assert from "node:assert/strict"; + +import { ModerationService } from "../../js/services/moderationService.js"; +import { withMockedNostrTools } from "../helpers/moderation-test-helpers.mjs"; + +function createRelayPublishingPool(publishCalls) { + return { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + setTimeout(() => handler(), 0); + return true; + } + return false; + }, + }; + }, + }; +} + +test("submitReport emits NIP-56 compliant report tags", async (t) => { + withMockedNostrTools(t); + + const reporterPubkey = "a".repeat(64); + const targetPubkey = "b".repeat(64); + const eventId = "c".repeat(64); + const relayHint = "wss://relay.example"; + + const extension = { + async signEvent(event) { + return { ...event, id: "signed-event", sig: "sig" }; + }, + }; + + const previousExtension = globalThis.window.nostr; + globalThis.window.nostr = extension; + t.after(() => { + if (typeof previousExtension === "undefined") { + delete globalThis.window.nostr; + } else { + globalThis.window.nostr = previousExtension; + } + }); + + const publishCalls = []; + const nostrClient = { + pubkey: reporterPubkey, + relays: ["wss://relay.one"], + ensurePool: async () => {}, + ensureExtensionPermissions: async () => ({ ok: true }), + pool: createRelayPublishingPool(publishCalls), + }; + + const service = new ModerationService({ nostrClient, logger: () => {} }); + + const { event, ok } = await service.submitReport({ + eventId, + type: "malware", + targetPubkey, + relayHint, + }); + + assert.equal(ok, true, "submitReport should resolve with ok: true"); + + const eTag = event.tags.find((tag) => Array.isArray(tag) && tag[0] === "e"); + assert.deepEqual( + eTag, + ["e", eventId, "malware", relayHint], + "e tag should include type before relay hint", + ); + + const pTag = event.tags.find((tag) => Array.isArray(tag) && tag[0] === "p"); + assert.deepEqual(pTag, ["p", targetPubkey, "malware"], "p tag should include reported author and type"); + + assert.equal( + event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "report").length, + 0, + "legacy report tag should be omitted", + ); + + const followupId = "d".repeat(64); + const { event: followup } = await service.submitReport({ + eventId: followupId, + type: "spam", + targetPubkey, + }); + + const followupETag = followup.tags.find((tag) => Array.isArray(tag) && tag[0] === "e"); + assert.deepEqual( + followupETag, + ["e", followupId, "spam"], + "e tag without relay hint should place type as third entry", + ); + + assert.ok(publishCalls.length >= 2, "submitReport should publish each report"); +}); diff --git a/tests/moderation/trusted-mute-lists.test.mjs b/tests/moderation/trusted-mute-lists.test.mjs index 108d70c3..fd4ea988 100644 --- a/tests/moderation/trusted-mute-lists.test.mjs +++ b/tests/moderation/trusted-mute-lists.test.mjs @@ -103,18 +103,24 @@ test("trusted mute lists from seeds hide authors for anonymous viewers", async ( await userBlocks.addBlock(mutedHex, seedHex); - const muteEvent = signedEvents.find((event) => event.kind === 10000); + const muteEvent = signedEvents.find( + (event) => + event.kind === 10000 && + Array.isArray(event.tags) && + event.tags.some((tag) => Array.isArray(tag) && tag[0] === "p"), + ); assert(muteEvent, "block list updates should publish a kind 10000 mute list event"); assert( - Array.isArray(muteEvent.tags) && - muteEvent.tags.some((tag) => Array.isArray(tag) && tag[0] === "p" && tag[1] === mutedHex), + muteEvent.tags.some((tag) => Array.isArray(tag) && tag[0] === "p" && tag[1] === mutedHex), "mute list event should include p-tags for blocked pubkeys", ); - assert.equal( - publishedEvents.filter((event) => event?.kind === 10000).length, - 1, - "mute list event should be published to relays", + const publishedMuteEvents = publishedEvents.filter( + (event) => + event?.kind === 10000 && + Array.isArray(event.tags) && + event.tags.some((tag) => Array.isArray(tag) && tag[0] === "p"), ); + assert(publishedMuteEvents.length >= 1, "mute list event should be published to relays"); const { service } = createModerationServiceHarness(t, { userBlocks }); service.refreshViewerFromClient = async () => {}; diff --git a/tests/nip71-base-event-tags.test.mjs b/tests/nip71-base-event-tags.test.mjs index fbe1dbaa..b1050579 100644 --- a/tests/nip71-base-event-tags.test.mjs +++ b/tests/nip71-base-event-tags.test.mjs @@ -86,3 +86,21 @@ test("30078 events carry nip71 metadata tags and hydrate fallback metadata", () assert.deepEqual(video.nip71.references, ["https://example.com/info"]); assert.equal(video.nip71Source?.eventId, "event-123"); }); + +test("imeta tags lower-case mime values", () => { + const metadataInput = { + imeta: [ + { m: "VIDEO/MP4", url: "https://cdn.example/video.mp4" }, + { m: "APPLICATION/DASH+XML" }, + ], + }; + + const tags = buildNip71MetadataTags(metadataInput); + const mimeEntries = tags + .filter((tag) => tag[0] === "imeta") + .map((tag) => tag.find((value) => typeof value === "string" && value.startsWith("m "))) + .filter(Boolean) + .map((entry) => entry.slice(2)); + + assert.deepEqual(mimeEntries, ["video/mp4", "application/dash+xml"]); +}); diff --git a/tests/nip71-builder.test.mjs b/tests/nip71-builder.test.mjs index d4860da9..6fa005be 100644 --- a/tests/nip71-builder.test.mjs +++ b/tests/nip71-builder.test.mjs @@ -6,13 +6,54 @@ import { extractNip71MetadataFromTags, } from "../js/nostr.js"; +const participantNpub = "npub1bitvidparticipantfixture"; +const participantHexFromNpub = "c".repeat(64); + +const hadWindow = typeof globalThis.window !== "undefined"; +const windowRef = hadWindow ? globalThis.window : {}; +if (!hadWindow) { + globalThis.window = windowRef; +} +const hadNostrTools = typeof windowRef.NostrTools !== "undefined"; +const nostrToolsRef = hadNostrTools ? windowRef.NostrTools : {}; +if (!hadNostrTools) { + windowRef.NostrTools = nostrToolsRef; +} +const previousNip19 = nostrToolsRef.nip19; +nostrToolsRef.nip19 = { + ...previousNip19, + decode: (value) => { + if (value === participantNpub) { + return { type: "npub", data: participantHexFromNpub }; + } + if (typeof previousNip19?.decode === "function") { + return previousNip19.decode(value); + } + throw new Error("Unsupported npub fixture"); + }, +}; + +test.after(() => { + if (previousNip19) { + nostrToolsRef.nip19 = previousNip19; + } else { + delete nostrToolsRef.nip19; + } + if (!hadNostrTools) { + delete windowRef.NostrTools; + } + if (!hadWindow) { + delete globalThis.window; + } +}); + test("buildNip71VideoEvent assembles rich metadata", () => { const metadata = { kind: 21, summary: "Custom summary", publishedAt: "1700000000", alt: "Alt text for accessibility", - duration: 123, + duration: 123.456, contentWarning: "Flashing lights", imeta: [ { @@ -20,6 +61,8 @@ test("buildNip71VideoEvent assembles rich metadata", () => { url: "https://cdn.example/video-1080.mp4", x: "abc123", m: "video/mp4", + duration: 123.456, + bitrate: 4500000, image: [ "https://cdn.example/video-1080.jpg", "https://backup.example/video-1080.jpg", @@ -30,6 +73,8 @@ test("buildNip71VideoEvent assembles rich metadata", () => { { url: "https://cdn.example/video-hls.m3u8", m: "application/x-mpegURL", + duration: "45.789", + bitrate: "2200000", }, ], textTracks: [ @@ -49,8 +94,8 @@ test("buildNip71VideoEvent assembles rich metadata", () => { ], hashtags: ["bitvid", "nostr"], participants: [ - { pubkey: "a".repeat(64), relay: "wss://relay.example" }, - { pubkey: "b".repeat(64) }, + { pubkey: "A".repeat(64), relay: "wss://relay.example" }, + { pubkey: ` ${participantNpub} ` }, ], references: [ "https://example.com/info", @@ -76,7 +121,7 @@ test("buildNip71VideoEvent assembles rich metadata", () => { assert.deepEqual(tags.get("title"), ["title", "Test Video"]); assert.deepEqual(tags.get("published_at"), ["published_at", "1700000000"]); assert.deepEqual(tags.get("alt"), ["alt", "Alt text for accessibility"]); - assert.deepEqual(tags.get("duration"), ["duration", "123"]); + assert.ok(!tags.has("duration"), "duration should no longer be emitted as a top-level tag"); assert.deepEqual(tags.get("content-warning"), [ "content-warning", "Flashing lights", @@ -90,6 +135,8 @@ test("buildNip71VideoEvent assembles rich metadata", () => { "url https://cdn.example/video-1080.mp4", "x abc123", "m video/mp4", + "duration 123.456", + "bitrate 4500000", "image https://cdn.example/video-1080.jpg", "image https://backup.example/video-1080.jpg", "fallback https://fallback.example/video-1080.mp4", @@ -98,7 +145,9 @@ test("buildNip71VideoEvent assembles rich metadata", () => { assert.deepEqual(imetaTags[1], [ "imeta", "url https://cdn.example/video-hls.m3u8", - "m application/x-mpegURL", + "m application/x-mpegurl", + "duration 45.789", + "bitrate 2200000", ]); const textTrackTags = event.tags.filter((tag) => tag[0] === "text-track"); @@ -127,7 +176,7 @@ test("buildNip71VideoEvent assembles rich metadata", () => { const participantTags = event.tags.filter((tag) => tag[0] === "p"); assert.deepEqual(participantTags, [ ["p", "a".repeat(64), "wss://relay.example"], - ["p", "b".repeat(64)], + ["p", participantHexFromNpub], ]); const referenceTags = event.tags.filter((tag) => tag[0] === "r"); @@ -209,9 +258,14 @@ test("extractNip71MetadataFromTags parses metadata and pointers", () => { ["title", "Metadata Title"], ["published_at", "1700000100"], ["alt", "alt text"], - ["duration", "321"], ["content-warning", "Bright lights"], - ["imeta", "url https://cdn.example/video.mp4", "m video/mp4"], + [ + "imeta", + "url https://cdn.example/video.mp4", + "m video/mp4", + "duration 321.125", + "bitrate 2500000", + ], ["text-track", "https://cdn.example/captions.vtt", "captions", "en"], ["segment", "00:00", "00:10", "Intro", "https://cdn.example/thumb.jpg"], ["t", "nostr"], @@ -228,13 +282,15 @@ test("extractNip71MetadataFromTags parses metadata and pointers", () => { assert.ok(parsed, "parser should produce a result"); assert.deepEqual(parsed.metadata.title, "Metadata Title"); assert.deepEqual(parsed.metadata.summary, "Summary text"); - assert.equal(parsed.metadata.duration, 321); + assert.equal(parsed.metadata.duration, 321.125); assert.equal(parsed.metadata.alt, "alt text"); assert.equal(parsed.metadata.contentWarning, "Bright lights"); assert.deepEqual(parsed.metadata.hashtags, ["nostr"]); assert.deepEqual(parsed.metadata.references, ["https://example.com/info"]); assert.equal(parsed.metadata.textTracks.length, 1); assert.equal(parsed.metadata.imeta.length, 1); + assert.equal(parsed.metadata.imeta[0].duration, 321.125); + assert.equal(parsed.metadata.imeta[0].bitrate, 2500000); assert(parsed.pointers.videoRootIds.has("root-123")); assert(parsed.pointers.videoEventIds.has("event-456")); assert(parsed.pointers.dTags.has("d-pointer")); diff --git a/tests/nostr-boost-actions.test.mjs b/tests/nostr-boost-actions.test.mjs index 714813be..c44201d1 100644 --- a/tests/nostr-boost-actions.test.mjs +++ b/tests/nostr-boost-actions.test.mjs @@ -67,6 +67,10 @@ function createPublishClient({ actorPubkey = "", sessionPubkey = "", failPublish ensurePool: async () => pool, ensureSessionActor: async () => sessionPubkey, ensureExtensionPermissions: async () => ({ ok: true }), + fetchRawEventById: async (id, { relays: requestedRelays } = {}) => { + void requestedRelays; + return client.rawEvents.get(id) || null; + }, countEventsAcrossRelays: async () => ({ total: 0, perRelay: [] }), }; @@ -84,9 +88,11 @@ function createPublishClient({ actorPubkey = "", sessionPubkey = "", failPublish created_at: createdAt, eventId: "event123", eventRelay: "wss://origin", + publishRelay: "wss://relay.example", address: "30078:deadbeef:identifier", addressRelay: "wss://address", authorPubkey: "deadbeef", + targetKind: 1, }); assert.equal(event.kind, 6); @@ -98,13 +104,33 @@ function createPublishClient({ actorPubkey = "", sessionPubkey = "", failPublish assert.deepEqual(event.tags[2], ["p", "deadbeef"]); })(); +(function testBuildRepostEventRequiresRelay() { + const createdAt = 1_700_000_001; + + assert.throws( + () => + buildRepostEvent({ + pubkey: "actorpubkey", + created_at: createdAt, + eventId: "event456", + authorPubkey: "cafebabe", + targetKind: 30078, + }), + /missing-event-relay/, + ); +})(); + await (async function testRepostEventUsesSessionActorAndDerivesAddress() { const eventId = "test-event"; const authorPubkey = "f".repeat(64); const sessionPubkey = "a".repeat(64); const { client } = createPublishClient({ sessionPubkey }); - client.rawEvents.set(eventId, { id: eventId, pubkey: authorPubkey }); + client.rawEvents.set(eventId, { + id: eventId, + pubkey: authorPubkey, + relays: ["wss://relay.example"], + }); client.allEvents.set(eventId, { id: eventId, pubkey: authorPubkey, @@ -117,7 +143,7 @@ await (async function testRepostEventUsesSessionActorAndDerivesAddress() { client, eventId, options: { - pointer: ["e", eventId, "wss://origin"], + pointer: ["e", eventId], authorPubkey, }, resolveActiveSigner: () => null, @@ -129,9 +155,10 @@ await (async function testRepostEventUsesSessionActorAndDerivesAddress() { assert.equal(result.ok, true); assert.equal(result.sessionActor, true); assert.equal(result.signerPubkey, sessionPubkey); + assert.equal(result.event?.kind, 16); const tags = result.event?.tags || []; assert.ok(Array.isArray(tags), "Repost event should include tags"); - assert.deepEqual(tags[0], ["e", eventId, "wss://origin"]); + assert.deepEqual(tags[0], ["e", eventId, "wss://relay.example"]); assert.equal( tags.some((tag) => Array.isArray(tag) && tag[0] === "a" && tag[1].startsWith("30078:")), true, @@ -175,6 +202,118 @@ await (async function testRepostEventHandlesPublishFailure() { assert.ok(result.details instanceof Error); })(); +await (async function testRepostEventFailsWhenRelayMissing() { + const eventId = "repost-no-relay"; + const authorPubkey = "c".repeat(64); + const sessionPubkey = "e".repeat(64); + const { client } = createPublishClient({ sessionPubkey }); + + client.fetchRawEventById = async () => null; + + const result = await repostEvent({ + client, + eventId, + options: { + pointer: ["e", eventId], + authorPubkey, + }, + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + eventToAddressPointer: eventToAddressPointerStub, + }); + + assert.equal(result.ok, false); + assert.equal(result.error, "missing-event-relay"); + assert.ok(Array.isArray(result.details?.relays)); +})(); + +await (async function testRepostEventSerializesKindOneTargetsWhenSourceAvailable() { + const eventId = "repost-kind1-content"; + const authorPubkey = "d".repeat(64); + const sessionPubkey = "f".repeat(64); + const { client } = createPublishClient({ sessionPubkey }); + + const rawEvent = { + id: eventId, + pubkey: authorPubkey, + created_at: 1_700_000_100, + kind: 1, + tags: [], + content: "hello from kind1", + }; + + client.rawEvents.set(eventId, rawEvent); + + const result = await repostEvent({ + client, + eventId, + options: { + pointer: ["e", eventId, "wss://origin"], + authorPubkey, + }, + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + eventToAddressPointer: eventToAddressPointerStub, + }); + + assert.equal(result.ok, true); + const expectedContent = JSON.stringify(rawEvent); + assert.equal(result.event?.kind, 6); + assert.equal(result.event?.content, expectedContent); + assert.equal(result.source?.serialized, expectedContent); + assert.equal(result.source?.raw, rawEvent); +})(); + +await (async function testRepostEventSerializesGenericTargetsWhenSourceAvailable() { + const eventId = "repost-kind30078-content"; + const authorPubkey = "e".repeat(64); + const sessionPubkey = "g".repeat(64); + const { client } = createPublishClient({ sessionPubkey }); + + const identifier = "video-identifier"; + const rawEvent = { + id: eventId, + pubkey: authorPubkey, + created_at: 1_700_000_200, + kind: 30078, + tags: [["d", identifier]], + content: JSON.stringify({ version: 3, title: "Demo" }), + }; + + client.rawEvents.set(eventId, rawEvent); + + const address = `30078:${authorPubkey}:${identifier}`; + + const result = await repostEvent({ + client, + eventId, + options: { + pointer: ["e", eventId, "wss://origin"], + authorPubkey, + address, + addressRelay: "wss://origin", + }, + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + eventToAddressPointer: eventToAddressPointerStub, + }); + + assert.equal(result.ok, true); + const expectedContent = JSON.stringify(rawEvent); + assert.equal(result.event?.kind, 16); + assert.equal(result.event?.content, expectedContent); + assert.equal(result.source?.serialized, expectedContent); + assert.equal(result.source?.raw, rawEvent); + + const kTag = result.event?.tags?.find( + (tag) => Array.isArray(tag) && tag[0] === "k", + ); + assert.deepEqual(kTag, ["k", String(rawEvent.kind)]); +})(); + await (async function testMirrorEventIncludesHostedMetadata() { const eventId = "mirror-event"; const actorPubkey = "1".repeat(64); diff --git a/tests/nostr/comment-events.test.mjs b/tests/nostr/comment-events.test.mjs index c08693c2..7f8098af 100644 --- a/tests/nostr/comment-events.test.mjs +++ b/tests/nostr/comment-events.test.mjs @@ -6,13 +6,16 @@ import { publishComment, listVideoComments, subscribeVideoComments, + __testExports, } from "../../js/nostr/commentEvents.js"; +const { normalizeCommentTarget, isVideoCommentEvent } = __testExports; + function createMockClient({ actorPubkey = "actor-pubkey", - sessionPrivateKey = "session-private", relays = ["wss://primary"], publishResults = [], + extensionPermissions = { ok: true }, } = {}) { const publishCalls = []; const pool = { @@ -34,29 +37,14 @@ function createMockClient({ sub: () => ({ on() {}, unsub() {} }), }; - const ensureSessionActorCalls = []; const client = { pool, relays, pubkey: actorPubkey, - sessionActor: { - pubkey: actorPubkey, - privateKey: sessionPrivateKey, - }, - ensureSessionActor: async (forceRefresh = false) => { - ensureSessionActorCalls.push(forceRefresh); - if (forceRefresh && !client.sessionActor) { - client.sessionActor = { - pubkey: actorPubkey, - privateKey: sessionPrivateKey, - }; - } - return actorPubkey; - }, - ensureExtensionPermissions: async () => ({ ok: true }), + ensureExtensionPermissions: async () => extensionPermissions, }; - return { client, pool, publishCalls, ensureSessionActorCalls }; + return { client, pool, publishCalls }; } function buildCommentEventTags(event) { @@ -83,8 +71,6 @@ test("publishComment prefers active signer when available", async () => { }, }; - let privateKeySignCalls = 0; - const result = await publishComment( client, { @@ -102,10 +88,6 @@ test("publishComment prefers active signer when available", async () => { { resolveActiveSigner: () => signer, shouldRequestExtensionPermissions: () => true, - signEventWithPrivateKey: () => { - privateKeySignCalls += 1; - return null; - }, DEFAULT_NIP07_PERMISSION_METHODS: ["signEvent"], }, ); @@ -127,41 +109,31 @@ test("publishComment prefers active signer when available", async () => { "publish should target the caller supplied relays", ); - assert.equal(privateKeySignCalls, 0, "session key signing should be skipped when active signer succeeds"); assert.equal(signerCalls.length, 1, "active signer should sign the event once"); const eventTags = buildCommentEventTags(signerCalls[0]); - const eTags = eventTags.filter((tag) => Array.isArray(tag) && tag[0] === "e"); - const aTags = eventTags.filter((tag) => Array.isArray(tag) && tag[0] === "a"); assert.deepEqual( - eTags, + eventTags, [ + ["A", "30078:deadbeef:clip", "wss://definition-relay"], + ["K", "30078"], + ["P", "deadbeef", "wss://definition-relay"], ["e", "video-event-id", "wss://video-relay"], - ["e", "parent-comment-id"], + ["a", "30078:deadbeef:clip", "wss://definition-relay"], + ["e", "parent-comment-id", "thread-participant"], + ["k", String(COMMENT_EVENT_KIND)], + ["p", "thread-participant"], ], - "comment event should include both video and parent pointers", - ); - assert.deepEqual( - aTags, - [["a", "30078:deadbeef:clip", "wss://definition-relay"]], - "comment event should target the video definition via #a tag", + "comment event should include NIP-22 root tags while preserving fallback markers", ); }); -test("publishComment falls back to session signer when active signer is missing", async () => { - const { - client, - publishCalls, - ensureSessionActorCalls, - } = createMockClient(); +test("publishComment rejects when active signer is unavailable", async () => { + const { client, publishCalls } = createMockClient(); - client.sessionActor = null; - - let privateKeySignCalls = 0; - const signEventWithPrivateKey = (event, key) => { - privateKeySignCalls += 1; - assert.equal(key, "session-private", "session key should be used when rehydrated"); - return { ...event, id: "signed-by-session" }; + client.sessionActor = { + pubkey: client.pubkey, + privateKey: "session-private", }; const result = await publishComment( @@ -174,30 +146,267 @@ test("publishComment falls back to session signer when active signer is missing" { resolveActiveSigner: () => null, shouldRequestExtensionPermissions: () => false, - signEventWithPrivateKey, DEFAULT_NIP07_PERMISSION_METHODS: [], }, ); - assert.equal(result.ok, true, "publish should succeed with session signer"); - assert.equal(privateKeySignCalls, 1, "session signing should occur exactly once"); - assert.equal( - ensureSessionActorCalls.includes(true), - true, - "ensureSessionActor should be invoked with force refresh", - ); - assert.equal(publishCalls.length, 1, "publish should still occur once"); + assert.equal(result.ok, false, "publish should fail without an active signer"); + assert.equal(result.error, "auth-required", "missing signer should yield auth-required"); + assert.equal(publishCalls.length, 0, "publish should not be attempted without a signer"); }); -test("listVideoComments builds filters with both #e and #a tags", async () => { +test("publishComment accepts legacy targets with only an event id", async () => { + const { client, publishCalls } = createMockClient(); + + let signCalls = 0; + const signer = { + type: "extension", + pubkey: client.pubkey, + signEvent: (event) => { + signCalls += 1; + return { ...event, id: `signed-${signCalls}` }; + }, + }; + + const result = await publishComment( + client, + { + videoEventId: "legacy-event-id", + parentCommentId: "parent-legacy", + }, + { content: "Legacy comment" }, + { + resolveActiveSigner: () => signer, + shouldRequestExtensionPermissions: () => false, + DEFAULT_NIP07_PERMISSION_METHODS: [], + }, + ); + + assert.equal(result.ok, true, "publishing should succeed without a definition address"); + assert.equal(signCalls, 1, "active signer should be used to sign the event"); + assert.equal(publishCalls.length, 1, "event should be published exactly once"); + + const publishedEvent = publishCalls[0]?.event; + const tags = buildCommentEventTags(publishedEvent); + assert.deepEqual( + tags, + [ + ["E", "legacy-event-id"], + ["K", String(COMMENT_EVENT_KIND)], + ["e", "legacy-event-id"], + ["e", "parent-legacy"], + ["k", String(COMMENT_EVENT_KIND)], + ], + "legacy publish should emit uppercase root metadata with lowercase fallbacks", + ); +}); + +test("publishComment derives root and parent metadata from parent comment tags", async () => { + const { client } = createMockClient(); + + const parentEvent = { + id: "parent-comment", + kind: COMMENT_EVENT_KIND, + pubkey: "parentpk", + tags: [ + ["E", "video-event", "wss://root", "videopk"], + ["K", "30078"], + ["P", "videopk", "wss://author"], + ["A", "30078:videopk:root", "wss://definition"], + ["e", "video-event", "wss://root"], + ["e", "parent-comment", "wss://parent", "parentpk"], + ["k", String(COMMENT_EVENT_KIND)], + ["p", "parentpk", "wss://parent"], + ], + }; + + const signer = { + type: "extension", + pubkey: client.pubkey, + signEvent: (event) => ({ ...event, id: "signed" }), + }; + + const result = await publishComment( + client, + { parentComment: parentEvent }, + { content: "Reply" }, + { + resolveActiveSigner: () => signer, + shouldRequestExtensionPermissions: () => false, + DEFAULT_NIP07_PERMISSION_METHODS: [], + }, + const tags = buildCommentEventTags(result.event); + assert.deepEqual(tags, [ + ["A", "30078:videopk:root", "wss://definition"], + ["K", "30078"], + ["P", "videopk", "wss://author"], + ["e", "video-event", "wss://root"], + ["a", "30078:videopk:root", "wss://definition"], + ["e", "parent-comment", "wss://parent", "parentpk"], + ["k", String(COMMENT_EVENT_KIND)], + ["p", "parentpk", "wss://parent"], + ]); +}); + +test("listVideoComments matches comments even when tag casing and whitespace differ", async () => { + const mismatchedEvent = { + id: "case-comment", + kind: COMMENT_EVENT_KIND, + created_at: 1700000300, + tags: [ + [" A ", " 30078:AUTHOR:CLIP ", " WSS://Definition "], + ["e", " VIDEO-1 "], + [" E ", " VIDEO-1 "], + ["e", " PARENT-1 "], + ["k", String(COMMENT_EVENT_KIND)], + ["p", " THREAD-PARTICIPANT "], + ], + }; + + const { client, pool } = createMockClient(); + pool.list = async () => [[mismatchedEvent]]; + + const descriptorInput = { + videoEventId: " video-1 ", + videoDefinitionAddress: " 30078:author:clip ", + parentCommentId: " parent-1 ", + }; + + const events = await listVideoComments(client, descriptorInput); + assert.equal(events.length, 1, "case-insensitive descriptor should match comment"); + assert.equal(events[0].id, "case-comment", "matched event should be returned"); + + const normalizedDescriptor = normalizeCommentTarget(descriptorInput); + assert.ok(normalizedDescriptor, "normalizeCommentTarget should produce a descriptor"); + assert.equal( + isVideoCommentEvent(mismatchedEvent, normalizedDescriptor), + true, + "isVideoCommentEvent should treat tag casing and whitespace as insignificant", + ); +}); + +test("listVideoComments matches uppercase definition addresses without lowering", async () => { + const uppercasePointer = "30078:AUTHOR:Clip42"; + const matchingEvent = { + id: "uppercase-comment", + kind: COMMENT_EVENT_KIND, + created_at: 1700000400, + tags: [ + ["A", uppercasePointer], + ["e", "video-1"], + ], + }; + + const { client, pool } = createMockClient(); + pool.list = async () => [[matchingEvent]]; + + const descriptorInput = { + videoEventId: "video-1", + videoDefinitionAddress: uppercasePointer, + }; + + const events = await listVideoComments(client, descriptorInput); + assert.equal(events.length, 1, "uppercase pointer should still match"); + assert.equal(events[0].id, "uppercase-comment", "matched event should be returned"); + + const normalizedDescriptor = normalizeCommentTarget(descriptorInput); + assert.ok(normalizedDescriptor, "normalizeCommentTarget should produce a descriptor"); + assert.equal( + isVideoCommentEvent(matchingEvent, normalizedDescriptor), + true, + "isVideoCommentEvent should respect descriptor casing for definition pointers", + ); +}); +test("listVideoComments matches comments even when tag casing and whitespace differ", async () => { + const mismatchedEvent = { + id: "case-comment", + kind: COMMENT_EVENT_KIND, + created_at: 1700000300, + tags: [ + [" A ", " 30078:AUTHOR:CLIP ", " WSS://Definition "], + ["e", " VIDEO-1 "], + [" E ", " VIDEO-1 "], + ["e", " PARENT-1 "], + ["k", String(COMMENT_EVENT_KIND)], + ["p", " THREAD-PARTICIPANT "], + ], + }; + + const { client, pool } = createMockClient(); + pool.list = async () => [[mismatchedEvent]]; + + const descriptorInput = { + videoEventId: " video-1 ", + videoDefinitionAddress: " 30078:author:clip ", + parentCommentId: " parent-1 ", + }; + + const events = await listVideoComments(client, descriptorInput); + assert.equal(events.length, 1, "case-insensitive descriptor should match comment"); + assert.equal(events[0].id, "case-comment", "matched event should be returned"); + + const normalizedDescriptor = normalizeCommentTarget(descriptorInput); + assert.ok(normalizedDescriptor, "normalizeCommentTarget should produce a descriptor"); + assert.equal( + isVideoCommentEvent(mismatchedEvent, normalizedDescriptor), + true, + "isVideoCommentEvent should treat tag casing and whitespace as insignificant", + ); +}); + + ["p", "parentpk", "wss://parent"], + ]); +}); + +test("publishComment emits only video event #e tag when address and parent are absent", async () => { + const { client, publishCalls } = createMockClient(); + + const signer = { + type: "extension", + pubkey: client.pubkey, + signEvent: (event) => ({ ...event, id: "solo" }), + }; + + const result = await publishComment( + client, + { + videoEventId: "video-only", + }, + { content: "Solo" }, + { + resolveActiveSigner: () => signer, + shouldRequestExtensionPermissions: () => false, + DEFAULT_NIP07_PERMISSION_METHODS: [], + }, + ); + + assert.equal(result.ok, true, "publishing should succeed with only a video id"); + assert.equal(publishCalls.length, 1, "comment should be published once"); + + const publishedEvent = publishCalls[0]?.event; + const tags = buildCommentEventTags(publishedEvent); + assert.deepEqual( + tags, + [ + ["E", "video-only"], + ["e", "video-only"], + ], + "event should include an uppercase root pointer along with the legacy #e tag", + ); +}); + +test("listVideoComments builds filters with uppercase roots plus legacy fallbacks", async () => { const matchingEventLatest = { id: "comment-2", kind: COMMENT_EVENT_KIND, created_at: 1700000200, tags: [ - ["e", "video-1"], - ["a", "30078:author:clip"], + ["A", "30078:author:clip"], + ["K", "30078"], + ["P", "author"], ["e", "parent-1"], + ["k", String(COMMENT_EVENT_KIND)], + ["p", "thread-participant"], ], }; @@ -206,7 +415,6 @@ test("listVideoComments builds filters with both #e and #a tags", async () => { kind: COMMENT_EVENT_KIND, created_at: 1690000000, tags: [ - ["e", "video-1"], ["a", "30078:author:clip"], ["e", "parent-1"], ], @@ -216,7 +424,7 @@ test("listVideoComments builds filters with both #e and #a tags", async () => { id: "comment-3", kind: COMMENT_EVENT_KIND, created_at: 1700000100, - tags: [["e", "video-1"]], + tags: [["a", "30078:author:clip"]], }; const { @@ -236,6 +444,8 @@ test("listVideoComments builds filters with both #e and #a tags", async () => { videoEventId: "video-1", videoDefinitionAddress: "30078:author:clip", parentCommentId: "parent-1", + parentKind: COMMENT_EVENT_KIND, + parentAuthorPubkey: "thread-participant", }, { relays: ["wss://history"], since: 1700000000, limit: 10 }, ); @@ -250,21 +460,142 @@ test("listVideoComments builds filters with both #e and #a tags", async () => { ["wss://history"], "list should use caller provided relays", ); - assert.equal(receivedFilters.filters.length, 1, "exactly one filter should be emitted"); - const [filter] = receivedFilters.filters; - assert.equal(filter.kinds[0], COMMENT_EVENT_KIND, "filter should target comment kind"); - assert.deepEqual( - filter["#e"], - ["video-1", "parent-1"], - "filter should bind the video and parent ids via #e", + assert.equal( + receivedFilters.filters.length, + 4, + "event, uppercase, parent, and address filters should be emitted", + ); + const [eventFilter, uppercaseFilter, parentFilter, definitionFilter] = + receivedFilters.filters; + assert.equal( + eventFilter.kinds[0], + COMMENT_EVENT_KIND, + "event filter should target comment kind", ); assert.deepEqual( - filter["#a"], + eventFilter["#e"], + ["video-1"], + "event filter should target the video via #e", + ); + assert.equal( + uppercaseFilter.kinds[0], + COMMENT_EVENT_KIND, + "uppercase filter should target comment kind", + ); + assert.deepEqual( + uppercaseFilter["#A"], ["30078:author:clip"], - "filter should bind the video definition via #a", + "uppercase filter should target the video definition via #A", + ); + assert.deepEqual( + uppercaseFilter["#K"], + ["30078"], + "uppercase filter should scope the root kind via #K", + ); + assert.deepEqual( + uppercaseFilter["#P"], + ["author"], + "uppercase filter should scope the root author via #P", + ); + assert.equal( + uppercaseFilter.since, + 1700000000, + "since option should propagate to uppercase filter", + ); + assert.equal( + uppercaseFilter.limit, + 10, + "limit option should propagate to uppercase filter", + ); + assert.deepEqual( + parentFilter, + { + kinds: [COMMENT_EVENT_KIND], + "#e": ["parent-1"], + since: 1700000000, + limit: 10, + }, + "parent filter should scope the thread via #e", + ); + assert.equal( + eventFilter.since, + 1700000000, + "since option should propagate to event filter", + ); + assert.equal( + eventFilter.limit, + 10, + "limit option should propagate to event filter", + ); + + assert.equal( + definitionFilter.kinds[0], + COMMENT_EVENT_KIND, + "definition filter should target comment kind", + ); + assert.deepEqual( + definitionFilter["#a"], + ["30078:author:clip"], + "definition filter should bind the video definition via #a", + ); + assert.deepEqual( + definitionFilter["#e"], + ["parent-1"], + "definition filter should continue scoping to the parent comment", + ); + assert.equal( + definitionFilter.since, + 1700000000, + "since option should propagate to definition filter", + ); + assert.equal( + definitionFilter.limit, + 10, + "limit option should propagate to definition filter", + ); +}); + +test("listVideoComments supports legacy targets without a definition address", async () => { + const legacyEvent = { + id: "legacy-comment", + kind: COMMENT_EVENT_KIND, + tags: [["e", "legacy-video"]], + }; + + const { client, pool } = createMockClient(); + + let receivedFilters = null; + pool.list = async (relays, filters) => { + receivedFilters = { relays, filters }; + return [[legacyEvent]]; + }; + + const events = await listVideoComments(client, { videoEventId: "legacy-video" }); + + assert.ok(Array.isArray(events), "listing should still return an array"); + assert.equal(events.length, 1, "legacy matching comment should be returned"); + assert.equal(events[0].id, "legacy-comment", "returned event should match the pool payload"); + + assert.ok(receivedFilters, "pool.list should be invoked with filters"); + assert.deepEqual( + receivedFilters.relays, + client.relays, + "legacy listing should fall back to client relays when none are provided", + ); + assert.deepEqual( + receivedFilters.filters, + [ + { + kinds: [COMMENT_EVENT_KIND], + "#e": ["legacy-video"], + }, + { + kinds: [COMMENT_EVENT_KIND], + "#E": ["legacy-video"], + }, + ], + "legacy listing should target the video event id via #e/#E", ); - assert.equal(filter.since, 1700000000, "since option should propagate to filter"); - assert.equal(filter.limit, 10, "limit option should propagate to filter"); }); test("subscribeVideoComments forwards matching events and cleans up unsubscribe", async () => { @@ -300,6 +631,8 @@ test("subscribeVideoComments forwards matching events and cleans up unsubscribe" videoEventId: "video-1", videoDefinitionAddress: "30078:author:clip", parentCommentId: "parent-1", + parentKind: COMMENT_EVENT_KIND, + parentAuthorPubkey: "thread-participant", }, { relays: ["wss://live"], @@ -317,26 +650,42 @@ test("subscribeVideoComments forwards matching events and cleans up unsubscribe" ["wss://live"], "subscription should use caller provided relays", ); - assert.equal(subscriptionArgs.filters.length, 1, "subscription should emit a single filter"); - const [subFilter] = subscriptionArgs.filters; assert.deepEqual( - subFilter["#e"], - ["video-1", "parent-1"], - "subscription filter should bind video and parent ids", - ); - assert.deepEqual( - subFilter["#a"], - ["30078:author:clip"], - "subscription filter should bind the video definition", + subscriptionArgs.filters, + [ + { + kinds: [COMMENT_EVENT_KIND], + "#e": ["video-1"], + }, + { + kinds: [COMMENT_EVENT_KIND], + "#A": ["30078:author:clip"], + "#K": ["30078"], + "#P": ["author"], + }, + { + kinds: [COMMENT_EVENT_KIND], + "#e": ["parent-1"], + }, + { + kinds: [COMMENT_EVENT_KIND], + "#a": ["30078:author:clip"], + "#e": ["parent-1"], + }, + ], + "subscription should emit event, parent, and address filters", ); handler({ id: "comment-accepted", kind: COMMENT_EVENT_KIND, tags: [ - ["e", "video-1"], - ["a", "30078:author:clip"], + ["A", "30078:author:clip"], + ["K", "30078"], + ["P", "author"], ["e", "parent-1"], + ["k", String(COMMENT_EVENT_KIND)], + ["p", "thread-participant"], ], }); @@ -354,3 +703,59 @@ test("subscribeVideoComments forwards matching events and cleans up unsubscribe" assert.equal(unsubCalls, 1, "underlying unsubscribe should only run once"); }); + +test("subscribeVideoComments supports video targets without a definition address", async () => { + const { client, pool } = createMockClient(); + + let handler = null; + let subscriptionArgs = null; + pool.sub = (relays, filters) => { + subscriptionArgs = { relays, filters }; + return { + on(name, cb) { + if (name === "event") { + handler = cb; + } + }, + unsub() {}, + }; + }; + + const receivedEvents = []; + subscribeVideoComments( + client, + { videoEventId: "legacy-video" }, + { + onEvent: (event) => { + receivedEvents.push(event); + }, + }, + ); + + assert.ok(subscriptionArgs, "subscription should capture filters"); + assert.deepEqual( + subscriptionArgs.filters, + [ + { + kinds: [COMMENT_EVENT_KIND], + "#e": ["legacy-video"], + }, + { + kinds: [COMMENT_EVENT_KIND], + "#E": ["legacy-video"], + }, + ], + "subscription should emit both legacy and uppercase video filters when address is absent", + ); + + assert.ok(handler, "event handler should be registered"); + + handler({ + id: "legacy-comment", + kind: COMMENT_EVENT_KIND, + tags: [["e", "legacy-video"]], + }); + + assert.equal(receivedEvents.length, 1, "legacy comment should be forwarded"); + assert.equal(receivedEvents[0].id, "legacy-comment", "comment payload should be delivered"); +}); diff --git a/tests/nostr/edit-video-dtag.test.mjs b/tests/nostr/edit-video-dtag.test.mjs new file mode 100644 index 00000000..dd3b5070 --- /dev/null +++ b/tests/nostr/edit-video-dtag.test.mjs @@ -0,0 +1,166 @@ +import "../test-helpers/setup-localstorage.mjs"; +import test from "node:test"; +import assert from "node:assert/strict"; +import { + NostrClient, + setActiveSigner, + clearActiveSigner, +} from "../../js/nostr.js"; + +const noop = () => {}; + +function createStubPool() { + return { + publish(urls, event) { + noop(event); + return { + on(type, handler) { + if (type === "ok") { + handler(); + return true; + } + if (type === "failed") { + return true; + } + return false; + }, + }; + }, + }; +} + +test("editVideo preserves existing d tag", async (t) => { + const client = new NostrClient(); + const pubkey = "ABC123"; + const existingD = "stable-d-tag"; + const baseEvent = { + id: "event-original", + pubkey, + version: 3, + videoRootId: "root-abc", + title: "Original Title", + url: "https://example.com/video.mp4", + magnet: "magnet:?xt=urn:btih:example", + ws: "wss://example.com", + xs: "https://example.com/file.torrent", + enableComments: true, + isPrivate: false, + isNsfw: false, + isForKids: false, + nip71: null, + thumbnail: "https://example.com/thumb.jpg", + description: "original", + mode: "live", + tags: [ + ["t", "video"], + ["d", existingD], + ], + }; + + client.getEventById = async (id) => (id === baseEvent.id ? baseEvent : null); + client.relays = ["wss://relay.one"]; + client.pool = createStubPool(); + client.ensureExtensionPermissions = async () => ({ ok: true }); + + const signedEvents = []; + const signer = { + type: "app", + pubkey, + signEvent: async (event) => { + signedEvents.push(event); + return { ...event, id: `signed-${signedEvents.length}` }; + }, + }; + + setActiveSigner(signer); + client.ensureActiveSignerForPubkey = async () => signer; + + t.after(() => { + clearActiveSigner(); + signedEvents.length = 0; + }); + + const result = await client.editVideo({ id: baseEvent.id }, { title: "Updated" }, pubkey); + + assert.ok(result, "editVideo should return the signed event"); + assert.equal(signedEvents.length, 1, "editVideo should sign exactly one event"); + const signedEvent = signedEvents[0]; + assert.ok(signedEvent, "signed event should be captured"); + const dTags = signedEvent.tags.filter((tag) => Array.isArray(tag) && tag[0] === "d"); + assert.deepEqual(dTags, [["d", existingD]], "editVideo should preserve the existing d tag"); + + const parsedContent = JSON.parse(signedEvent.content); + assert.equal( + parsedContent.videoRootId, + baseEvent.videoRootId, + "editVideo should preserve the original videoRootId", + ); +}); + +test("editVideo falls back to base event id when d tag missing", async (t) => { + const client = new NostrClient(); + const pubkey = "ABC123"; + const baseEvent = { + id: "event-original-no-d", + pubkey, + version: 3, + videoRootId: "root-abc", + title: "Original Title", + url: "https://example.com/video.mp4", + magnet: "magnet:?xt=urn:btih:example", + ws: "wss://example.com", + xs: "https://example.com/file.torrent", + enableComments: true, + isPrivate: false, + isNsfw: false, + isForKids: false, + nip71: null, + thumbnail: "https://example.com/thumb.jpg", + description: "original", + mode: "live", + tags: [["t", "video"]], + }; + + client.getEventById = async (id) => (id === baseEvent.id ? baseEvent : null); + client.relays = ["wss://relay.one"]; + client.pool = createStubPool(); + client.ensureExtensionPermissions = async () => ({ ok: true }); + + const signedEvents = []; + const signer = { + type: "app", + pubkey, + signEvent: async (event) => { + signedEvents.push(event); + return { ...event, id: `signed-${signedEvents.length}` }; + }, + }; + + setActiveSigner(signer); + client.ensureActiveSignerForPubkey = async () => signer; + + t.after(() => { + clearActiveSigner(); + signedEvents.length = 0; + }); + + const result = await client.editVideo({ id: baseEvent.id }, { title: "Updated" }, pubkey); + + assert.ok(result, "editVideo should return the signed event"); + assert.equal(signedEvents.length, 1, "editVideo should sign exactly one event"); + const signedEvent = signedEvents[0]; + assert.ok(signedEvent, "signed event should be captured"); + const dTags = signedEvent.tags.filter((tag) => Array.isArray(tag) && tag[0] === "d"); + assert.deepEqual( + dTags, + [["d", baseEvent.id]], + "editVideo should fall back to the base event id for the d tag when none exists", + ); + + const parsedContent = JSON.parse(signedEvent.content); + assert.equal( + parsedContent.videoRootId, + baseEvent.videoRootId, + "editVideo should continue to use the original videoRootId", + ); +}); diff --git a/tests/nostr/nip71.test.js b/tests/nostr/nip71.test.js index d6169e04..d9055f65 100644 --- a/tests/nostr/nip71.test.js +++ b/tests/nostr/nip71.test.js @@ -21,12 +21,13 @@ test("buildNip71MetadataTags normalizes structured fields", () => { { dim: " 1920x1080 ", url: " https://cdn.example/thumb.jpg ", + duration: " 29.5 ", + bitrate: " 3000000 ", image: [" https://cdn.example/fallback-1.jpg ", ""], fallback: [" https://cdn.example/fallback-2.jpg "], service: [" thumb "], }, ], - duration: " 123 ", textTracks: [ { url: " https://cdn.example/captions.vtt ", @@ -54,12 +55,14 @@ test("buildNip71MetadataTags normalizes structured fields", () => { tag[0] === "imeta" && tag.includes("dim 1920x1080") && tag.includes("url https://cdn.example/thumb.jpg") && + tag.includes("duration 29.5") && + tag.includes("bitrate 3000000") && tag.includes("image https://cdn.example/fallback-1.jpg") && tag.includes("fallback https://cdn.example/fallback-2.jpg") && tag.includes("service thumb"), ), ); - assert.ok(tags.some((tag) => tag[0] === "duration" && tag[1] === "123")); + assert.ok(!tags.some((tag) => tag[0] === "duration")); assert.ok( tags.some( (tag) => @@ -89,7 +92,7 @@ test("buildNip71MetadataTags normalizes structured fields", () => { tags.some( (tag) => tag[0] === "p" && - tag[1] === "A".repeat(64) && + tag[1] === "a".repeat(64) && tag[2] === "wss://relay.example", ), ); diff --git a/tests/nostr/publishHelpers.test.mjs b/tests/nostr/publishHelpers.test.mjs new file mode 100644 index 00000000..edb5cb4d --- /dev/null +++ b/tests/nostr/publishHelpers.test.mjs @@ -0,0 +1,143 @@ +import assert from "node:assert/strict"; +import test from "node:test"; + +const { mirrorVideoEvent, repostEvent } = await import( + "../../js/nostr/publishHelpers.js", +); + +const resolveActiveSignerStub = () => ({ + signEvent: async (event) => ({ + ...event, + id: `${event.kind}-${event.created_at}`, + sig: "active-signature", + }), +}); + +const shouldRequestExtensionPermissionsStub = () => false; + +const signEventWithPrivateKeyStub = (event) => ({ + ...event, + id: `${event.kind}-${event.created_at}-session`, + sig: "session-signature", +}); + +function createPublishClient({ actorPubkey = "" } = {}) { + const publishCalls = []; + const pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + } + return true; + }, + }; + }, + }; + + const client = { + pubkey: actorPubkey, + relays: ["wss://relay.example"], + writeRelays: ["wss://relay.example"], + pool, + allEvents: new Map(), + rawEvents: new Map(), + ensurePool: async () => pool, + ensureSessionActor: async () => actorPubkey, + ensureExtensionPermissions: async () => ({ ok: true }), + }; + + if (actorPubkey) { + client.sessionActor = { + pubkey: actorPubkey, + privateKey: "session-private-key", + }; + } + + return { client, publishCalls }; +} + +test("mirrorVideoEvent lowercases provided MIME types", async () => { + const eventId = "provided-mime"; + const actorPubkey = "1".repeat(64); + const { client } = createPublishClient({ actorPubkey }); + + const result = await mirrorVideoEvent({ + client, + eventId, + options: { + url: "https://videos.example/demo.mp4", + mimeType: "Video/MP4", + }, + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + inferMimeTypeFromUrl: () => "", + }); + + assert.equal(result.ok, true); + const mTag = result.event?.tags?.find( + (tag) => Array.isArray(tag) && tag[0] === "m", + ); + assert.ok(mTag, "mirror events must include a MIME tag"); + assert.equal(mTag[1], "video/mp4"); +}); + +test("mirrorVideoEvent lowercases inferred MIME types", async () => { + const eventId = "inferred-mime"; + const actorPubkey = "2".repeat(64); + const { client } = createPublishClient({ actorPubkey }); + + const result = await mirrorVideoEvent({ + client, + eventId, + options: { + url: "https://videos.example/demo.webm", + }, + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + inferMimeTypeFromUrl: () => "VIDEO/WEBM", + }); + + assert.equal(result.ok, true); + const mTag = result.event?.tags?.find( + (tag) => Array.isArray(tag) && tag[0] === "m", + ); + assert.ok(mTag, "mirror events must include a MIME tag"); + assert.equal(mTag[1], "video/webm"); +}); + +test("mirrorVideoEvent includes hash tags when provided", async () => { + const eventId = "hash-tags"; + const actorPubkey = "3".repeat(64); + const { client } = createPublishClient({ actorPubkey }); + const fileHash = "a".repeat(64); + const originalHash = "b".repeat(64); + + const result = await mirrorVideoEvent({ + client, + eventId, + options: { + url: "https://videos.example/demo.mp4", + fileSha256: fileHash.toUpperCase(), + originalFileSha256: originalHash, + }, + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + inferMimeTypeFromUrl: () => "video/mp4", + }); + + assert.equal(result.ok, true); + const xTag = result.event?.tags?.find( + (tag) => Array.isArray(tag) && tag[0] === "x", + ); + const oxTag = result.event?.tags?.find( + (tag) => Array.isArray(tag) && tag[0] === "ox", + ); + assert.deepEqual(xTag, ["x", fileHash]); + assert.deepEqual(oxTag, ["ox", originalHash]); +}); diff --git a/tests/nostr/reaction-events.test.mjs b/tests/nostr/reaction-events.test.mjs new file mode 100644 index 00000000..8aea7e24 --- /dev/null +++ b/tests/nostr/reaction-events.test.mjs @@ -0,0 +1,125 @@ +import assert from "node:assert/strict"; +import test from "node:test"; + +const { publishVideoReaction } = await import("../../js/nostr/reactionEvents.js"); + +function createReactionClient({ actorPubkey = "" } = {}) { + const publishCalls = []; + const pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + } + return true; + }, + }; + }, + }; + + const client = { + pubkey: actorPubkey, + relays: ["wss://relay.example"], + pool, + ensureExtensionPermissions: async () => ({ ok: true }), + async ensureSessionActor() { + if (!this.sessionActor) { + this.sessionActor = { + pubkey: actorPubkey, + privateKey: "session-private-key", + }; + } + return actorPubkey; + }, + }; + + if (actorPubkey) { + client.sessionActor = { + pubkey: actorPubkey, + privateKey: "session-private-key", + }; + } + + return { client, publishCalls }; +} + +const resolveActiveSignerStub = () => ({ + signEvent: async (event) => ({ + ...event, + id: `${event.kind}-${event.created_at}`, + sig: "active-signature", + }), +}); + +const shouldRequestExtensionPermissionsStub = () => false; + +const signEventWithPrivateKeyStub = (event) => ({ + ...event, + id: `${event.kind}-${event.created_at}-session`, + sig: "session-signature", +}); + +test("publishVideoReaction includes both address and event tags when reacting to addressable content", async () => { + const actorPubkey = "0".repeat(64); + const { client, publishCalls } = createReactionClient({ actorPubkey }); + + const result = await publishVideoReaction( + client, + { type: "a", value: "30078:deadbeefcafebabe:clip-1", relay: "wss://relay.address" }, + { + pointerEventId: "target-event-id", + pointerEventRelay: "wss://event.relay", + }, + { + resolveActiveSigner: resolveActiveSignerStub, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + DEFAULT_NIP07_PERMISSION_METHODS: [], + }, + ); + + assert.equal(result.ok, true, "reaction publish should succeed"); + assert.equal(publishCalls.length, 1, "reaction should publish exactly once"); + + const tags = publishCalls[0].event.tags || []; + const addressTags = tags.filter((tag) => Array.isArray(tag) && tag[0] === "a"); + const eventTags = tags.filter((tag) => Array.isArray(tag) && tag[0] === "e"); + + assert.deepEqual(addressTags, [[ + "a", + "30078:deadbeefcafebabe:clip-1", + "wss://relay.address", + ]]); + + assert.deepEqual(eventTags, [["e", "target-event-id", "wss://event.relay"]]); +}); + +test("publishVideoReaction aborts when address pointer is missing a resolvable event id", async () => { + const actorPubkey = "f".repeat(64); + const { client, publishCalls } = createReactionClient({ actorPubkey }); + + const result = await publishVideoReaction( + client, + "30078:abcdef:clip-1", + {}, + { + resolveActiveSigner: () => { + throw new Error("resolveActiveSigner should not be called when validation fails"); + }, + shouldRequestExtensionPermissions: shouldRequestExtensionPermissionsStub, + signEventWithPrivateKey: signEventWithPrivateKeyStub, + DEFAULT_NIP07_PERMISSION_METHODS: [], + }, + ); + + assert.equal(result.ok, false, "reaction publish should fail when event id is missing"); + assert.equal(result.error, "missing-pointer-event-id"); + assert.match( + result.details, + /Unable to resolve event id/, + "error details should explain why the publish failed", + ); + assert.equal(publishCalls.length, 0, "reaction should not publish when validation fails"); +}); diff --git a/tests/nostr/revert-video-dtag.test.mjs b/tests/nostr/revert-video-dtag.test.mjs new file mode 100644 index 00000000..758a109c --- /dev/null +++ b/tests/nostr/revert-video-dtag.test.mjs @@ -0,0 +1,127 @@ +import "../test-helpers/setup-localstorage.mjs"; +import test from "node:test"; +import assert from "node:assert/strict"; +import { + NostrClient, + setActiveSigner, + clearActiveSigner, +} from "../../js/nostr.js"; + +function createStubPool() { + return { + publish(urls, event) { + void urls; + void event; + return { + on(type, handler) { + if (type === "ok") { + handler(); + return true; + } + if (type === "failed") { + return true; + } + return false; + }, + }; + }, + }; +} + +test("revertVideo preserves existing d tag", async (t) => { + const client = new NostrClient(); + const pubkey = "ABC123"; + const existingD = "stable-d-tag"; + const baseEvent = { + id: "event-original", + pubkey, + content: JSON.stringify({ + version: 3, + videoRootId: "root-abc", + }), + tags: [ + ["t", "video"], + ["d", existingD], + ], + }; + + const signedEvents = []; + const signer = { + type: "app", + pubkey, + signEvent: async (event) => { + signedEvents.push(event); + return { ...event, id: `signed-${signedEvents.length}` }; + }, + }; + + client.relays = ["wss://relay.one"]; + client.pool = createStubPool(); + client.ensureExtensionPermissions = async () => ({ ok: true }); + client.ensureActiveSignerForPubkey = async () => signer; + + setActiveSigner(signer); + + t.after(() => { + clearActiveSigner(); + }); + + const result = await client.revertVideo(baseEvent, pubkey); + + assert.ok(result?.event, "revertVideo should return the signed event"); + const signedEvent = signedEvents[0]; + assert.ok(signedEvent, "revertVideo should sign the revert event"); + const dTags = signedEvent.tags.filter((tag) => Array.isArray(tag) && tag[0] === "d"); + assert.deepEqual( + dTags, + [["d", existingD]], + "revertVideo should preserve the existing d tag", + ); +}); + +test("revertVideo falls back to original event id when d tag missing", async (t) => { + const client = new NostrClient(); + const pubkey = "ABC123"; + const baseEvent = { + id: "event-legacy", + pubkey, + content: JSON.stringify({ + version: 2, + videoRootId: "event-legacy", + }), + tags: [["t", "video"]], + }; + + const signedEvents = []; + const signer = { + type: "app", + pubkey, + signEvent: async (event) => { + signedEvents.push(event); + return { ...event, id: `signed-${signedEvents.length}` }; + }, + }; + + client.relays = ["wss://relay.one"]; + client.pool = createStubPool(); + client.ensureExtensionPermissions = async () => ({ ok: true }); + client.ensureActiveSignerForPubkey = async () => signer; + + setActiveSigner(signer); + + t.after(() => { + clearActiveSigner(); + }); + + const result = await client.revertVideo(baseEvent, pubkey); + + assert.ok(result?.event, "revertVideo should return the signed event"); + const signedEvent = signedEvents[0]; + assert.ok(signedEvent, "revertVideo should sign the revert event"); + const dTags = signedEvent.tags.filter((tag) => Array.isArray(tag) && tag[0] === "d"); + assert.deepEqual( + dTags, + [["d", baseEvent.id]], + "revertVideo should reuse the original event id for the d tag when missing", + ); +}); diff --git a/tests/nwc-client.test.mjs b/tests/nwc-client.test.mjs index 3e7cec80..15eb186d 100644 --- a/tests/nwc-client.test.mjs +++ b/tests/nwc-client.test.mjs @@ -13,11 +13,13 @@ await (async () => { invoice: "bolt11-invoice", amountSats: 123, zapRequest: "zap-request-json", + lnurl: " https://pay.example/lnurlp/test ", }); assert.equal(params.invoice, "bolt11-invoice"); assert.equal(params.amount, 123_000); assert.equal(params.zap_request, "zap-request-json"); + assert.equal(params.lnurl, "https://pay.example/lnurlp/test"); })(); await (async () => { @@ -63,6 +65,14 @@ await (async () => { }, }, }, + nip04: { + async encrypt() { + return "nip04"; + }, + async decrypt() { + return "nip04"; + }, + }, }; const walletPubkey = "b".repeat(64); @@ -103,6 +113,107 @@ await (async () => { resetWalletClient(); })(); +await (async () => { + resetWalletClient(); + + window.NostrTools = { + getPublicKey() { + return "c".repeat(64); + }, + nip44: { + v2: { + async encrypt(plaintext, key) { + return `nip44:${key}:${plaintext}`; + }, + async decrypt(ciphertext, key) { + return `nip44:${key}:${ciphertext}`; + }, + utils: { + getConversationKey(secretBytes, pubkey) { + return `key-${pubkey}-${secretBytes.length}`; + }, + }, + }, + }, + nip04: { + async encrypt() { + return "nip04"; + }, + async decrypt() { + return "nip04"; + }, + }, + }; + + const walletPubkey = "b".repeat(64); + const secretKey = "a".repeat(64); + const relays = ["wss://relay.one.example"]; + const uri = + `nostr+walletconnect://${walletPubkey}` + + `?relay=${encodeURIComponent(relays[0])}` + + `&secret=${secretKey}`; + + const context = ensureActiveState({ nwcUri: uri }); + context.infoEvent = { kind: 13194, tags: [] }; + + const encryption = await __TESTING__.ensureEncryptionForContext(context); + assert.equal(encryption.scheme, "nip04"); + + resetWalletClient(); +})(); + +await (async () => { + resetWalletClient(); + + window.NostrTools = { + getPublicKey() { + return "c".repeat(64); + }, + nip44: { + v2: { + async encrypt(plaintext, key) { + return `nip44:${key}:${plaintext}`; + }, + async decrypt(ciphertext, key) { + return `nip44:${key}:${ciphertext}`; + }, + utils: { + getConversationKey(secretBytes, pubkey) { + return `key-${pubkey}-${secretBytes.length}`; + }, + }, + }, + }, + nip04: { + async encrypt() { + return "nip04"; + }, + async decrypt() { + return "nip04"; + }, + }, + }; + + const walletPubkey = "b".repeat(64); + const secretKey = "a".repeat(64); + const relays = ["wss://relay.one.example"]; + const uri = + `nostr+walletconnect://${walletPubkey}` + + `?relay=${encodeURIComponent(relays[0])}` + + `&secret=${secretKey}`; + + const context = ensureActiveState({ nwcUri: uri }); + context.infoEvent = { + kind: 13194, + tags: [["encryption", "nip04"]], + }; + + const encryption = await __TESTING__.ensureEncryptionForContext(context); + assert.equal(encryption.scheme, "nip04"); + + resetWalletClient(); +})(); + await (async () => { resetWalletClient(); @@ -148,4 +259,300 @@ await (async () => { resetWalletClient(); })(); +await (async () => { + resetWalletClient(); + + window.NostrTools = { + getPublicKey() { + return "c".repeat(64); + }, + nip44: { + v2: { + async encrypt(plaintext, key) { + return `nip44:${key}:${plaintext}`; + }, + async decrypt(ciphertext, key) { + return `nip44:${key}:${ciphertext}`; + }, + utils: { + getConversationKey(secretBytes, pubkey) { + return `key-${pubkey}-${secretBytes.length}`; + }, + }, + }, + }, + nip04: { + async encrypt() { + return "nip04"; + }, + async decrypt() { + return "nip04"; + }, + }, + }; + + const walletPubkey = "b".repeat(64); + const secretKey = "a".repeat(64); + const relays = ["wss://relay.one.example"]; + const uri = + `nostr+walletconnect://${walletPubkey}` + + `?relay=${encodeURIComponent(relays[0])}` + + `&secret=${secretKey}`; + + const context = ensureActiveState({ nwcUri: uri }); + context.infoEvent = { + kind: 13194, + tags: [["encryption", "nip44_v2 nip04"]], + }; + context.encryptionState.unsupported.add("nip44_v2"); + + const encryption = await __TESTING__.ensureEncryptionForContext(context); + assert.equal(encryption.scheme, "nip04"); + + resetWalletClient(); +})(); + +await (async () => { + resetWalletClient(); + + const originalWebSocket = globalThis.WebSocket; + const RESPONSE_KIND = 23195; + + class FakeWebSocket { + constructor(url) { + this.url = url; + this.readyState = FakeWebSocket.CONNECTING; + this._listeners = new Map(); + this._responseSubscriptionId = null; + setTimeout(() => { + this.readyState = FakeWebSocket.OPEN; + this._emit("open"); + }, 0); + } + + addEventListener(type, handler) { + if (!this._listeners.has(type)) { + this._listeners.set(type, new Set()); + } + this._listeners.get(type).add(handler); + } + + removeEventListener(type, handler) { + const listeners = this._listeners.get(type); + if (listeners) { + listeners.delete(handler); + } + } + + send(payload) { + let parsed; + try { + parsed = JSON.parse(payload); + } catch (error) { + return; + } + + const [type] = parsed; + if (type === "REQ") { + const subscription = parsed[1]; + const filters = parsed[2]; + if (filters?.kinds && filters.kinds.includes(RESPONSE_KIND)) { + this._responseSubscriptionId = subscription; + } + return; + } + + if (type === "EVENT") { + const event = parsed[1]; + const state = __TESTING__.getActiveState(); + const context = state?.context || null; + const encryption = context?.encryption || null; + if (!context || !encryption || !this._responseSubscriptionId) { + return; + } + + Promise.resolve() + .then(() => encryption.decrypt(event.content)) + .then((plaintext) => { + const requestPayload = JSON.parse(plaintext); + const responsePayload = { + id: requestPayload.id, + result_type: "pay_invoice", + result: { preimage: "test-preimage" }, + }; + return encryption.encrypt(JSON.stringify(responsePayload)); + }) + .then((ciphertext) => { + if (!ciphertext) { + return; + } + const tools = window.NostrTools || {}; + const responseEvent = { + pubkey: context.walletPubkey, + kind: RESPONSE_KIND, + content: ciphertext, + tags: [ + ["p", context.clientPubkey], + ["e", event.id], + ], + created_at: Math.floor(Date.now() / 1000), + }; + if (typeof tools.getEventHash === "function") { + responseEvent.id = tools.getEventHash(responseEvent); + } else { + responseEvent.id = `resp-${Date.now()}`; + } + if (typeof tools.signEvent === "function") { + responseEvent.sig = tools.signEvent(responseEvent, context.secretKey); + } + const message = JSON.stringify([ + "EVENT", + this._responseSubscriptionId, + responseEvent, + ]); + setTimeout(() => { + this._emit("message", { data: message }); + }, 0); + }) + .catch(() => {}); + } + } + + close() { + this.readyState = FakeWebSocket.CLOSED; + this._emit("close", {}); + } + + _emit(type, event = {}) { + const listeners = this._listeners.get(type); + if (!listeners) { + return; + } + for (const handler of Array.from(listeners)) { + try { + handler(event); + } catch (error) { + // ignore + } + } + } + } + + FakeWebSocket.CONNECTING = 0; + FakeWebSocket.OPEN = 1; + FakeWebSocket.CLOSED = 3; + + globalThis.WebSocket = FakeWebSocket; + + let eventCounter = 0; + const encode = (value) => Buffer.from(value, "utf8").toString("base64"); + const decode = (value) => Buffer.from(value, "base64").toString("utf8"); + + window.NostrTools = { + getPublicKey() { + return "c".repeat(64); + }, + getEventHash(event) { + eventCounter += 1; + return `event-${eventCounter}`; + }, + signEvent(event) { + return `sig-${event.id || "unknown"}`; + }, + nip04: { + async encrypt(secretKey, pubkey, plaintext) { + return `nip04:${encode(plaintext)}`; + }, + async decrypt(secretKey, pubkey, ciphertext) { + const payload = + typeof ciphertext === "string" && ciphertext.startsWith("nip04:") + ? ciphertext.slice("nip04:".length) + : ciphertext; + return decode(payload); + }, + }, + nip44: { + v2: { + async encrypt(plaintext, key) { + return `nip44:${key}:${encode(plaintext)}`; + }, + async decrypt(ciphertext, key) { + if (typeof ciphertext !== "string") { + return ""; + } + const parts = ciphertext.split(":"); + const encoded = parts.slice(2).join(":"); + return decode(encoded); + }, + utils: { + getConversationKey(secretBytes, pubkey) { + return `key-${pubkey}-${secretBytes.length}`; + }, + }, + }, + }, + }; + + const walletPubkey = "b".repeat(64); + const secretKey = "a".repeat(64); + const relay = "wss://relay.budget.example"; + const budget = 1000n; + const uri = + `nostr+walletconnect://${walletPubkey}` + + `?relay=${encodeURIComponent(relay)}` + + `&secret=${secretKey}` + + `&budget=${budget.toString()}`; + + const context = ensureActiveState({ nwcUri: uri }); + context.infoEvent = { kind: 13194, tags: [["encryption", "nip04"]] }; + + try { + const first = await nwcModule.sendPayment("lnbc1budgettest", { + settings: { nwcUri: uri }, + amountSats: 1, + }); + + assert.ok(first); + assert.ok(context.budgetTracker); + assert.equal(context.budgetTracker.totalMsats, budget); + assert.equal(context.budgetTracker.spentMsats, 1000n); + + await assert.rejects( + () => + nwcModule.sendPayment("lnbc1budgettest", { + settings: { nwcUri: uri }, + amountSats: 1, + }), + (error) => { + assert.equal(error.code, "NWC_BUDGET_EXHAUSTED"); + assert.match(error.message || "", /Budget exceeded/i); + return true; + } + ); + assert.equal(context.budgetTracker.exhausted, true); + + const higherBudget = 5000n; + const upgradedUri = + `nostr+walletconnect://${walletPubkey}` + + `?relay=${encodeURIComponent(relay)}` + + `&secret=${secretKey}` + + `&budget=${higherBudget.toString()}`; + + const nextContext = ensureActiveState({ nwcUri: upgradedUri }); + nextContext.infoEvent = { kind: 13194, tags: [["encryption", "nip04"]] }; + + assert.ok(nextContext.budgetTracker); + assert.equal(nextContext.budgetTracker.totalMsats, higherBudget); + assert.equal(nextContext.budgetTracker.spentMsats, 0n); + assert.equal(nextContext.budgetTracker.exhausted, false); + } finally { + if (originalWebSocket) { + globalThis.WebSocket = originalWebSocket; + } else { + delete globalThis.WebSocket; + } + resetWalletClient(); + } +})(); + process.exit(0); diff --git a/tests/profile-modal-controller.test.mjs b/tests/profile-modal-controller.test.mjs index da81dd44..c56b951e 100644 --- a/tests/profile-modal-controller.test.mjs +++ b/tests/profile-modal-controller.test.mjs @@ -26,6 +26,20 @@ async function waitForAnimationFrame(window, cycles = 1) { } } +function createDeferred() { + let resolve; + let reject; + const promise = new Promise((res, rej) => { + resolve = res; + reject = rej; + }); + return { + promise, + resolve, + reject, + }; +} + function createMatchMediaList(query, initialMatches = false) { let matches = Boolean(initialMatches); const listeners = new Set(); @@ -384,6 +398,122 @@ for (const _ of [0]) { }, ); + test( + 'Add profile request suspends focus trap and elevates login modal', + async (t) => { + const loginDeferred = createDeferred(); + const loginModal = document.createElement('div'); + loginModal.id = 'loginModal'; + loginModal.className = 'bv-modal hidden'; + container.appendChild(loginModal); + + const controller = createController({ + services: { + requestAddProfileLogin: async ({ triggerElement }) => { + assert.strictEqual(triggerElement, controller.addAccountButton); + assert.equal(controller.focusTrapSuspended, true); + return loginDeferred.promise; + }, + }, + callbacks: { + onAddAccount: async () => {}, + }, + }); + + let cleanupRan = false; + const cleanup = () => { + try { + loginModal.remove(); + } catch {} + try { + controller.hide({ silent: true }); + } catch {} + cleanupRan = true; + }; + + try { + await controller.load(); + applyDesignSystemAttributes(document); + await controller.show('account'); + await waitForAnimationFrame(window, 1); + + const loginPromise = controller.handleAddAccountRequest(); + await Promise.resolve(); + + const profileModalRoot = + document.getElementById('profileModal') || controller.profileModal; + assert.ok(profileModalRoot, 'profile modal root should exist'); + assert.equal( + profileModalRoot?.dataset.nestedModalActive, + 'true', + 'profile modal should mark nested modal state', + ); + assert.equal( + profileModalRoot?.getAttribute('aria-hidden'), + 'true', + 'profile modal should be hidden from assistive tech', + ); + + const panel = + profileModalRoot?.querySelector('.bv-modal__panel') || profileModalRoot; + assert.ok(panel?.hasAttribute('inert')); + + assert.equal( + profileModalRoot?.style.visibility, + 'hidden', + 'profile modal should hide visually while login modal is active', + ); + assert.equal( + profileModalRoot?.style.pointerEvents, + 'none', + 'profile modal should not intercept pointer events while login modal is active', + ); + + assert.strictEqual( + container.lastElementChild, + loginModal, + 'login modal should be last in the container', + ); + + loginDeferred.resolve({ provider: 'test' }); + await loginPromise; + await waitForAnimationFrame(window, 1); + + assert.equal(controller.focusTrapSuspended, false); + assert.equal( + profileModalRoot?.dataset.nestedModalActive, + undefined, + 'profile modal nested state should clear after login', + ); + assert.equal( + profileModalRoot?.getAttribute('aria-hidden'), + 'false', + 'profile modal should restore aria-hidden', + ); + assert.equal(panel?.hasAttribute('inert'), false); + assert.equal( + profileModalRoot?.style.visibility ?? '', + '', + 'profile modal visibility should restore after login', + ); + assert.equal( + profileModalRoot?.style.pointerEvents ?? '', + '', + 'profile modal pointer events should restore after login', + ); + } finally { + cleanup(); + } + + t.after(() => { + if (!cleanupRan) { + cleanup(); + } + resetRuntimeFlags(); + }); + }, + ); + test( 'Profile modal navigation buttons toggle active state', async (t) => { diff --git a/tests/reaction-event-builder.test.mjs b/tests/reaction-event-builder.test.mjs index 1d3100da..a5476d2b 100644 --- a/tests/reaction-event-builder.test.mjs +++ b/tests/reaction-event-builder.test.mjs @@ -21,19 +21,38 @@ test("buildReactionEvent includes pointer and author tags when pubkey provided", assert.deepEqual(authorTags, [["p", "author-pubkey", "wss://relay.example"]]); }); -test("buildReactionEvent derives author pubkey from address pointer", () => { - const event = buildReactionEvent({ - pubkey: "viewer", - created_at: 1700000001, - pointerValue: "30078:deadbeefcafebabe:clip-1", - pointerTag: ["a", "30078:deadbeefcafebabe:clip-1"], - targetPointer: { type: "a", value: "30078:deadbeefcafebabe:clip-1" }, - content: "+", - }); +test( + "buildReactionEvent merges address and event pointers for addressable targets", + () => { + const event = buildReactionEvent({ + pubkey: "viewer", + created_at: 1700000001, + pointerValue: "30078:deadbeefcafebabe:clip-1", + pointerTag: ["a", "30078:deadbeefcafebabe:clip-1"], + pointerTags: [ + ["a", "30078:deadbeefcafebabe:clip-1", "wss://relay.example"], + ["e", "event-id"], + ["e", "event-id", "wss://event.relay"], + ], + targetPointer: { + type: "a", + value: "30078:deadbeefcafebabe:clip-1", + relay: "wss://relay.example", + }, + content: "+", + }); - const addressTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "a"); - assert.deepEqual(addressTags, [["a", "30078:deadbeefcafebabe:clip-1"]]); + const addressTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "a"); + assert.deepEqual(addressTags, [[ + "a", + "30078:deadbeefcafebabe:clip-1", + "wss://relay.example", + ]]); - const authorTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "p"); - assert.deepEqual(authorTags, [["p", "deadbeefcafebabe"]]); -}); + const eventTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "e"); + assert.deepEqual(eventTags, [["e", "event-id", "wss://event.relay"]]); + + const authorTags = event.tags.filter((tag) => Array.isArray(tag) && tag[0] === "p"); + assert.deepEqual(authorTags, [["p", "deadbeefcafebabe", "wss://relay.example"]]); + } +); diff --git a/tests/subscriptions-manager.test.mjs b/tests/subscriptions-manager.test.mjs index 6a751196..e7c50597 100644 --- a/tests/subscriptions-manager.test.mjs +++ b/tests/subscriptions-manager.test.mjs @@ -8,6 +8,7 @@ import { subscriptions } from "../js/subscriptions.js"; import { setApplication } from "../js/applicationContext.js"; import nostrService from "../js/services/nostrService.js"; import moderationService from "../js/services/moderationService.js"; +import { getNostrEventSchema, NOTE_TYPES } from "../js/nostrEventSchemas.js"; test("loadSubscriptions aggregates relay results when one rejects", async () => { const SubscriptionsManager = subscriptions.constructor; @@ -55,7 +56,7 @@ test("loadSubscriptions aggregates relay results when one rejects", async () => const listCalls = []; nostrClient.pool = { - list(urls) { + list(urls, _filters) { const url = Array.isArray(urls) ? urls[0] : urls; listCalls.push(url); if (url === "wss://relay-b.example") { @@ -73,7 +74,7 @@ test("loadSubscriptions aggregates relay results when one rejects", async () => async decrypt(_pubkey, ciphertext) { decryptCalls.push(ciphertext); if (ciphertext === "cipher-new") { - return JSON.stringify({ subPubkeys: ["pub-new"] }); + return JSON.stringify([["p", "pub-new"]]); } return JSON.stringify({ subPubkeys: ["pub-old"] }); }, @@ -130,6 +131,83 @@ test("loadSubscriptions aggregates relay results when one rejects", async () => } }); +test("loadSubscriptions queries legacy kind fallback for pre-migration events", async () => { + const SubscriptionsManager = subscriptions.constructor; + const manager = new SubscriptionsManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalWriteRelays = Array.isArray(nostrClient.writeRelays) + ? [...nostrClient.writeRelays] + : nostrClient.writeRelays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + + const hadWindow = typeof globalThis.window !== "undefined"; + if (!hadWindow) { + globalThis.window = {}; + } + const originalWindowNostr = globalThis.window.nostr; + + const relayUrls = ["wss://relay-legacy.example"]; + nostrClient.relays = relayUrls; + nostrClient.writeRelays = relayUrls; + + const capturedFilters = []; + nostrClient.pool = { + list(urls, filters) { + const filterArray = Array.isArray(filters) ? filters : []; + if (filterArray.length) { + capturedFilters.push(filterArray[0]); + } + return Promise.resolve([]); + }, + }; + + nostrClient.ensureExtensionPermissions = async () => ({ ok: true }); + + try { + await manager.loadSubscriptions("user-pubkey-legacy"); + + assert.ok( + capturedFilters.length > 0, + "loadSubscriptions should pass subscription filters to pool.list", + ); + + const schemaKind = + getNostrEventSchema(NOTE_TYPES.SUBSCRIPTION_LIST)?.kind ?? 30000; + + for (const filter of capturedFilters) { + const kinds = Array.isArray(filter?.kinds) ? filter.kinds : []; + assert.ok(kinds.includes(schemaKind), "filter should include the active follow-set kind"); + assert.ok( + kinds.includes(30002), + "filter should include the legacy kind for backwards compatibility", + ); + const uniqueKinds = Array.from(new Set(kinds)); + assert.equal( + kinds.length, + uniqueKinds.length, + "filter kinds should not contain duplicate entries", + ); + } + } finally { + nostrClient.relays = originalRelays; + nostrClient.writeRelays = originalWriteRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + if (typeof originalWindowNostr === "undefined") { + delete globalThis.window.nostr; + } else { + globalThis.window.nostr = originalWindowNostr; + } + if (!hadWindow) { + delete globalThis.window; + } + } +}); + test("loadSubscriptions falls back to nip44 when hinted", async () => { const SubscriptionsManager = subscriptions.constructor; const manager = new SubscriptionsManager(); @@ -179,7 +257,7 @@ test("loadSubscriptions falls back to nip44 when hinted", async () => { nip44: { async decrypt(_pubkey, ciphertext) { decryptCalls.nip44 += 1; - return JSON.stringify({ subPubkeys: ["pub-nip44"], hint: ciphertext }); + return JSON.stringify([["p", "pub-nip44", ciphertext]]); }, }, }; @@ -264,7 +342,7 @@ test("loadSubscriptions handles nip44.v2 decryptors", async () => { v2: { async decrypt(_pubkey, ciphertext) { decryptCalls.nip44_v2 += 1; - return JSON.stringify({ subPubkeys: ["pub-nip44-v2"], hint: ciphertext }); + return JSON.stringify([["p", "pub-nip44-v2"], ["t", ciphertext]]); }, }, }, @@ -311,6 +389,88 @@ test("loadSubscriptions handles nip44.v2 decryptors", async () => { } }); +test("loadSubscriptions prefers nip44 decryptors when both are available", async () => { + const SubscriptionsManager = subscriptions.constructor; + const manager = new SubscriptionsManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalWriteRelays = Array.isArray(nostrClient.writeRelays) + ? [...nostrClient.writeRelays] + : nostrClient.writeRelays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + + const hadWindow = typeof globalThis.window !== "undefined"; + if (!hadWindow) { + globalThis.window = {}; + } + const originalWindowNostr = globalThis.window.nostr; + + const relayUrls = ["wss://relay-nip44-pref.example"]; + nostrClient.relays = relayUrls; + nostrClient.writeRelays = relayUrls; + + const event = { + id: "event-nip44-pref", + created_at: 700, + content: "cipher-nip44-pref", + tags: [["encrypted", "nip44_v2"]], + }; + + nostrClient.pool = { + list() { + return Promise.resolve([event]); + }, + }; + + nostrClient.ensureExtensionPermissions = async () => ({ ok: true }); + + const decryptCalls = { nip04: 0, nip44: 0 }; + globalThis.window.nostr = { + nip04: { + async decrypt() { + decryptCalls.nip04 += 1; + return JSON.stringify([["p", "pub-nip04"]]); + }, + }, + nip44: { + v2: { + async decrypt(_pubkey, ciphertext) { + decryptCalls.nip44 += 1; + return JSON.stringify([["p", "pub-nip44-pref", ciphertext]]); + }, + }, + }, + }; + + try { + await manager.loadSubscriptions("user-pubkey-123"); + + assert.deepEqual( + Array.from(manager.subscribedPubkeys), + ["pub-nip44-pref"], + "nip44 decrypted subscriptions should populate the set", + ); + assert.equal(decryptCalls.nip44, 1, "nip44 decryptor should be used"); + assert.equal(decryptCalls.nip04, 0, "nip04 decryptor should be skipped"); + } finally { + nostrClient.relays = originalRelays; + nostrClient.writeRelays = originalWriteRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + if (typeof originalWindowNostr === "undefined") { + delete globalThis.window.nostr; + } else { + globalThis.window.nostr = originalWindowNostr; + } + if (!hadWindow) { + delete globalThis.window; + } + } +}); + test( "loadSubscriptions uses active signer decryptors without requesting extension permissions", async () => { @@ -361,7 +521,7 @@ test( pubkey: "user-pubkey-123", async nip04Decrypt(pubkey, ciphertext) { decryptCalls.push({ pubkey, ciphertext }); - return JSON.stringify({ subPubkeys: ["pub-direct"] }); + return JSON.stringify([["p", "pub-direct"]]); }, }); @@ -630,7 +790,7 @@ test( encryptCalls[0], { pubkey: "user-pubkey-123", - plaintext: JSON.stringify({ subPubkeys: ["pub-direct"] }), + plaintext: JSON.stringify([["p", "pub-direct"]]), }, "nip04Encrypt should receive the serialized subscription list", ); @@ -651,6 +811,183 @@ test( }, ); +test("publishSubscriptionList prefers nip44 encryption when available", async () => { + const SubscriptionsManager = subscriptions.constructor; + const manager = new SubscriptionsManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalWriteRelays = Array.isArray(nostrClient.writeRelays) + ? [...nostrClient.writeRelays] + : nostrClient.writeRelays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + const originalSigner = getActiveSigner(); + + const relayUrls = ["wss://relay-prefer-nip44.example"]; + nostrClient.relays = relayUrls; + nostrClient.writeRelays = relayUrls; + + let permissionCalls = 0; + nostrClient.ensureExtensionPermissions = async () => { + permissionCalls += 1; + return { ok: true }; + }; + + const publishCalls = []; + nostrClient.pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + } + return true; + }, + }; + }, + }; + + const encryptCalls = { nip44: 0, nip04: 0 }; + const signedEvents = []; + setActiveSigner({ + type: "nsec", + pubkey: "user-pubkey-123", + async nip44Encrypt(pubkey, plaintext) { + encryptCalls.nip44 += 1; + assert.equal(pubkey, "user-pubkey-123"); + assert.equal( + plaintext, + JSON.stringify([["p", "pub-one"], ["p", "pub-two"]]), + ); + return "cipher-nip44"; + }, + async nip04Encrypt() { + encryptCalls.nip04 += 1; + throw new Error("nip04 should not be used when nip44 is available"); + }, + async signEvent(event) { + signedEvents.push(event); + return { ...event, id: "signed-nip44-event" }; + }, + }); + + manager.subscribedPubkeys = new Set(["pub-one", "pub-two"]); + + try { + await manager.publishSubscriptionList("user-pubkey-123"); + + assert.equal(permissionCalls, 0, "should not request extension permissions"); + assert.equal(encryptCalls.nip44, 1, "nip44Encrypt should be used once"); + assert.equal(encryptCalls.nip04, 0, "nip04Encrypt should not be invoked"); + assert.equal(signedEvents.length, 1, "signEvent should be called once"); + const signedEvent = signedEvents[0]; + const encryptedTags = signedEvent.tags.filter((tag) => tag[0] === "encrypted"); + assert.deepEqual( + encryptedTags, + [["encrypted", "nip44_v2"]], + "signed event should advertise nip44_v2 encryption", + ); + assert.equal(publishCalls.length, relayUrls.length, "event should publish to relays"); + assert.equal(manager.subsEventId, "signed-nip44-event"); + } finally { + nostrClient.relays = originalRelays; + nostrClient.writeRelays = originalWriteRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + setActiveSigner(originalSigner); + } +}); + +test("publishSubscriptionList falls back to nip04 when nip44 fails", async () => { + const SubscriptionsManager = subscriptions.constructor; + const manager = new SubscriptionsManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalWriteRelays = Array.isArray(nostrClient.writeRelays) + ? [...nostrClient.writeRelays] + : nostrClient.writeRelays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + const originalSigner = getActiveSigner(); + + const relayUrls = ["wss://relay-fallback-nip04.example"]; + nostrClient.relays = relayUrls; + nostrClient.writeRelays = relayUrls; + + nostrClient.ensureExtensionPermissions = async () => ({ ok: true }); + + const publishCalls = []; + nostrClient.pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + } + return true; + }, + }; + }, + }; + + const encryptCalls = { nip44: 0, nip04: 0 }; + const signedEvents = []; + setActiveSigner({ + type: "nsec", + pubkey: "user-pubkey-123", + async nip44Encrypt() { + encryptCalls.nip44 += 1; + throw new Error("simulated nip44 failure"); + }, + async nip04Encrypt(pubkey, plaintext) { + encryptCalls.nip04 += 1; + assert.equal(pubkey, "user-pubkey-123"); + assert.equal( + plaintext, + JSON.stringify([["p", "pub-three"]]), + ); + return "cipher-nip04"; + }, + async signEvent(event) { + signedEvents.push(event); + return { ...event, id: "signed-nip04-event" }; + }, + }); + + manager.subscribedPubkeys = new Set(["pub-three"]); + + try { + await manager.publishSubscriptionList("user-pubkey-123"); + + assert.ok( + encryptCalls.nip44 >= 1, + "nip44Encrypt should be attempted before falling back", + ); + assert.equal(encryptCalls.nip04, 1, "nip04Encrypt should handle fallback"); + const signedEvent = signedEvents[0]; + const encryptedTags = signedEvent.tags.filter((tag) => tag[0] === "encrypted"); + assert.deepEqual( + encryptedTags, + [["encrypted", "nip04"]], + "fallback nip04 encryption should advertise nip04", + ); + assert.equal(publishCalls.length, relayUrls.length, "event should publish to relays"); + assert.equal(manager.subsEventId, "signed-nip04-event"); + } finally { + nostrClient.relays = originalRelays; + nostrClient.writeRelays = originalWriteRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + setActiveSigner(originalSigner); + } +}); + test("renderSameGridStyle shows empty state message", async () => { const SubscriptionsManager = subscriptions.constructor; diff --git a/tests/ui/app-chrome-controller.test.mjs b/tests/ui/app-chrome-controller.test.mjs new file mode 100644 index 00000000..54d1f045 --- /dev/null +++ b/tests/ui/app-chrome-controller.test.mjs @@ -0,0 +1,58 @@ +import test from "node:test"; +import assert from "node:assert/strict"; +import { JSDOM } from "jsdom"; + +import AppChromeController from "../../js/ui/appChromeController.js"; + +test("AppChromeController binds upload button when elements hydrate later", () => { + const dom = new JSDOM(`<!DOCTYPE html><body><button id="upload"></button></body>`, { + url: "https://example.com", + }); + const { window } = dom; + + const previousWindow = global.window; + const previousDocument = global.document; + + global.window = window; + global.document = window.document; + + try { + const openCalls = []; + const controller = new AppChromeController({ + callbacks: { + openUploadModal: (detail) => { + openCalls.push(detail); + }, + }, + logger: { + error: () => {}, + log: () => {}, + }, + }); + + controller.initialize(); + + const uploadButton = window.document.getElementById("upload"); + controller.setElements({ uploadButton }); + + uploadButton.dispatchEvent(new window.Event("click", { bubbles: true })); + + assert.equal(openCalls.length, 1); + assert.equal(openCalls[0]?.triggerElement, uploadButton); + + const replacement = window.document.createElement("button"); + window.document.body.appendChild(replacement); + + controller.setElements({ uploadButton: replacement }); + + uploadButton.dispatchEvent(new window.Event("click", { bubbles: true })); + assert.equal(openCalls.length, 1); + + replacement.dispatchEvent(new window.Event("click", { bubbles: true })); + assert.equal(openCalls.length, 2); + assert.equal(openCalls[1]?.triggerElement, replacement); + } finally { + global.window = previousWindow; + global.document = previousDocument; + } +}); diff --git a/tests/ui/profileModalController.test.js b/tests/ui/profileModalController.test.js new file mode 100644 index 00000000..ba571976 --- /dev/null +++ b/tests/ui/profileModalController.test.js @@ -0,0 +1 @@ +import { ProfileModalController } from '../../js/ui/profileModalController.js';&#10;import { userLogger } from '../../js/utils/logger.js';&#10;&#10;describe('ProfileModalController - Direct Messages Error Handling', () =&gt; {&#10; let controller;&#10; let mockUserLoggerWarn;&#10;&#10; beforeEach(() =&gt; {&#10; jest.spyOn(userLogger, 'warn').mockImplementation(() =&gt; {});&#10; mockUserLoggerWarn = jest.spyOn(userLogger, 'warn');&#10; controller = new ProfileModalController({ /* minimal mocks for services/state */ });&#10; jest.spyOn(controller, 'setMessagesLoadingState');&#10; jest.spyOn(controller, 'setMessagesAnnouncement');&#10; jest.spyOn(controller, 'updateMessagesReloadState');&#10; controller.directMessagesCache = []; // Empty for error state&#10; });&#10;&#10; afterEach(() =&gt; {&#10; jest.restoreAllMocks();&#10; });&#10;&#10; it('handles &quot;no-decryptors&quot; with specific message, no warn log, and enables reload', () =&gt; {&#10; const detail = {&#10; context: { reason: 'no-decryptors' },&#10; error: new Error('Mock signer unlock error')&#10; };&#10; controller.handleDirectMessagesError(detail);&#10;&#10; expect(controller.setMessagesLoadingState).toHaveBeenCalledWith('error', {&#10; message: 'Unlock your signer to read direct messages.'&#10; });&#10; expect(mockUserLoggerWarn).not.toHaveBeenCalled(); // No log for this reason&#10; expect(controller.updateMessagesReloadState).toHaveBeenCalled(); // Reload affordance&#10; });&#10;&#10; it('handles other reasons with generic message, warn log, and enables reload', () =&gt; {&#10; const detail = {&#10; context: { reason: 'relay-failed' }, // Mock real transport error&#10; error: new Error('Mock relay error')&#10; };&#10; controller.handleDirectMessagesError(detail);&#10;&#10; expect(controller.setMessagesLoadingState).toHaveBeenCalledWith('error', {&#10; message: 'Unable to sync direct messages right now.'&#10; });&#10; expect(mockUserLoggerWarn).toHaveBeenCalledWith(&#10; '[profileModal] Direct message sync issue detected:',&#10; detail.error&#10; ); // Warn for transport errors&#10; expect(controller.updateMessagesReloadState).toHaveBeenCalled(); // Reload affordance&#10; });&#10;&#10; it('handles non-empty cache for &quot;no-decryptors&quot; (announcement only, no error state)', () =&gt; {&#10; controller.directMessagesCache = ['mock-message']; // Non-empty&#10; const detail = { context: { reason: 'no-decryptors' } };&#10; controller.handleDirectMessagesError(detail);&#10;&#10; // Uses announcement, not error state&#10; expect(controller.setMessagesAnnouncement).toHaveBeenCalledWith('Unable to sync direct messages right now.');&#10; expect(mockUserLoggerWarn).not.toHaveBeenCalled();&#10; });&#10;&#10; it('maintains behavior for active requests (ignores detail, no state change)', () =&gt; {&#10; controller.activeMessagesRequest = Symbol('active');&#10; const detail = { context: { reason: 'no-decryptors' } };&#10; controller.handleDirectMessagesError(detail);&#10;&#10; expect(controller.setMessagesLoadingState).not.toHaveBeenCalled();&#10; expect(controller.setMessagesAnnouncement).not.toHaveBeenCalled();&#10; expect(mockUserLoggerWarn).toHaveBeenCalled(); // Still logs for diagnostics&#10; });&#10;&#10;});&#10;&#10;// Adjust existing tests to cover &quot;no-decryptors&quot; in DM flows (e.g., error simulation in populateProfileMessages) diff --git a/tests/ui/video-list-view-popular-tags.test.mjs b/tests/ui/video-list-view-popular-tags.test.mjs index dfd18df5..15c8d017 100644 --- a/tests/ui/video-list-view-popular-tags.test.mjs +++ b/tests/ui/video-list-view-popular-tags.test.mjs @@ -59,6 +59,97 @@ test("VideoListView renders sorted popular tag pills", () => { ); }); +test("VideoListView trims popular tags to available width", () => { + const { dom, document, listRoot, tagsRoot } = createViewDom(); + const view = new VideoListView({ document }); + view.mount(listRoot); + view.setPopularTagsContainer(tagsRoot); + + const prototype = dom.window.HTMLElement.prototype; + const originalScrollWidth = Object.getOwnPropertyDescriptor( + prototype, + "scrollWidth", + ); + + Object.defineProperty(tagsRoot, "clientWidth", { + configurable: true, + value: 160, + }); + + Object.defineProperty(prototype, "scrollWidth", { + configurable: true, + get() { + if (this.classList && this.classList.contains("video-tag-strip")) { + return this.childElementCount * 80; + } + + if (originalScrollWidth && typeof originalScrollWidth.get === "function") { + return originalScrollWidth.get.call(this); + } + + return 0; + }, + }); + + try { + const videos = [ + { + id: "v1", + title: "First", + pubkey: "pub1", + created_at: 3, + nip71: { hashtags: ["Nostr", "Video"] }, + }, + { + id: "v2", + title: "Second", + pubkey: "pub2", + created_at: 2, + tags: [ + ["t", "nostr"], + ["t", "Learning"], + ], + }, + { + id: "v3", + title: "Third", + pubkey: "pub3", + created_at: 1, + nip71: { hashtags: ["video"] }, + }, + ]; + + view.render(videos); + + let buttons = tagsRoot.querySelectorAll("button"); + assert.equal(buttons.length, 2); + assert.deepEqual( + Array.from(buttons, (button) => button.dataset.tag), + ["Nostr", "Video"], + ); + + Object.defineProperty(tagsRoot, "clientWidth", { + configurable: true, + value: 400, + }); + + view.renderPopularTagStrip(); + + buttons = tagsRoot.querySelectorAll("button"); + assert.equal(buttons.length, 3); + assert.deepEqual( + Array.from(buttons, (button) => button.dataset.tag), + ["Nostr", "Video", "Learning"], + ); + } finally { + if (originalScrollWidth) { + Object.defineProperty(prototype, "scrollWidth", originalScrollWidth); + } else { + delete prototype.scrollWidth; + } + } +}); + test("VideoListView applies tag preference variants to popular tags", () => { const { document, listRoot, tagsRoot } = createViewDom(); const view = new VideoListView({ document }); diff --git a/tests/user-blocks.test.mjs b/tests/user-blocks.test.mjs index 30f71fee..044c2568 100644 --- a/tests/user-blocks.test.mjs +++ b/tests/user-blocks.test.mjs @@ -91,6 +91,7 @@ await (async () => { [relays[0]]: [ { id: "event-old", + kind: 10000, created_at: 1700, pubkey: actor, content: "ciphertext-old", @@ -99,6 +100,7 @@ await (async () => { [relays[1]]: [ { id: "event-new", + kind: 10000, created_at: 1800, pubkey: actor, content: "ciphertext-new", @@ -241,6 +243,7 @@ await (async () => { backgroundResolver.resolve([ { id: "background-event", + kind: 10000, pubkey: actor, created_at: 2_000, content: "ciphertext-background", @@ -490,9 +493,7 @@ await (async () => { let latestEventId = "event-initial"; let latestCreatedAt = 1_000; - const decryptPayloads = new Map([ - [latestCiphertext, JSON.stringify({ blockedPubkeys: [] })], - ]); + const decryptPayloads = new Map([[latestCiphertext, JSON.stringify([])]]); const signedEvents = []; @@ -516,6 +517,7 @@ await (async () => { list: async () => [ { id: latestEventId, + kind: 10000, created_at: latestCreatedAt, pubkey: actor, content: latestCiphertext, @@ -541,9 +543,18 @@ await (async () => { } catch (error) { throw new Error(`unexpected payload ${plaintext}`); } - const blocked = Array.isArray(parsed?.blockedPubkeys) - ? [...parsed.blockedPubkeys].sort() - : []; + let blocked; + if (Array.isArray(parsed)) { + blocked = parsed + .filter((tag) => Array.isArray(tag) && tag.length >= 2 && tag[0] === "p") + .map((tag) => tag[1]) + .filter((value) => typeof value === "string") + .sort(); + } else if (Array.isArray(parsed?.blockedPubkeys)) { + blocked = [...parsed.blockedPubkeys].sort(); + } else { + blocked = []; + } const cipher = `cipher:${JSON.stringify(blocked)}`; decryptPayloads.set(cipher, plaintext); return cipher; @@ -607,11 +618,15 @@ await (async () => { "direct signer flows should never trigger extension permission prompts", ); - const muteEvent = signedEvents.find((event) => event.kind === 10000); + const muteEvent = signedEvents.find( + (event) => + event.kind === 10000 && + Array.isArray(event.tags) && + event.tags.some((tag) => Array.isArray(tag) && tag[0] === "p"), + ); assert(muteEvent, "block list updates should publish a kind 10000 mute list event"); assert( - Array.isArray(muteEvent.tags) && - muteEvent.tags.some((tag) => Array.isArray(tag) && tag[0] === "p" && tag[1] === target), + muteEvent.tags.some((tag) => Array.isArray(tag) && tag[0] === "p" && tag[1] === target), "mute list event should include p-tags for blocked pubkeys", ); } finally { @@ -633,3 +648,399 @@ await (async () => { } } })(); + +await (async () => { + const actor = "1".repeat(64); + const blocked = "2".repeat(64); + + const UserBlockListManager = userBlocks.constructor; + const manager = new UserBlockListManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + const originalSigner = getActiveSigner(); + + const relayUrls = ["wss://relay-nip44-blocklist.example"]; + nostrClient.relays = relayUrls; + nostrClient.ensureExtensionPermissions = async () => ({ ok: true }); + + const publishCalls = []; + nostrClient.pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + } + return true; + }, + }; + }, + }; + + const encryptCalls = { nip44: 0, nip04: 0 }; + const signedEvents = []; + setActiveSigner({ + type: "nsec", + pubkey: actor, + async nip44Encrypt(pubkey, plaintext) { + encryptCalls.nip44 += 1; + assert.equal(pubkey, actor); + assert.equal( + plaintext, + JSON.stringify([["p", blocked]]), + ); + return "cipher-nip44"; + }, + async nip04Encrypt() { + encryptCalls.nip04 += 1; + throw new Error("nip04 should not be used when nip44 is available"); + }, + async signEvent(event) { + signedEvents.push(event); + return { ...event, id: "signed-nip44-block-event" }; + }, + }); + + manager.blockedPubkeys = new Set([blocked]); + manager.publishMuteListSnapshot = async () => null; + manager.loadBlocks = async () => {}; + + try { + const result = await manager.publishBlockList(actor); + + assert.equal(result.id, "signed-nip44-block-event"); + assert.equal(encryptCalls.nip44, 1, "nip44Encrypt should be used once"); + assert.equal(encryptCalls.nip04, 0, "nip04Encrypt should not be invoked"); + assert.equal(signedEvents.length, 1, "signEvent should be called once"); + const encryptedTags = signedEvents[0].tags.filter((tag) => tag[0] === "encrypted"); + assert.deepEqual( + encryptedTags, + [["encrypted", "nip44_v2"]], + "block list event should advertise nip44_v2 encryption", + ); + assert.equal(publishCalls.length, relayUrls.length, "event should publish to relays"); + } finally { + nostrClient.relays = originalRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + setActiveSigner(originalSigner); + } +})(); + +await (async () => { + const actor = "3".repeat(64); + const blocked = "4".repeat(64); + + const UserBlockListManager = userBlocks.constructor; + const manager = new UserBlockListManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + const originalSigner = getActiveSigner(); + + nostrClient.relays = ["wss://relay-nip04-fallback.example"]; + nostrClient.ensureExtensionPermissions = async () => ({ ok: true }); + + const publishCalls = []; + nostrClient.pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + } + return true; + }, + }; + }, + }; + + const encryptCalls = { nip44: 0, nip04: 0 }; + const signedEvents = []; + setActiveSigner({ + type: "nsec", + pubkey: actor, + async nip44Encrypt() { + encryptCalls.nip44 += 1; + throw new Error("simulated nip44 failure"); + }, + async nip04Encrypt(pubkey, plaintext) { + encryptCalls.nip04 += 1; + assert.equal(pubkey, actor); + assert.equal( + plaintext, + JSON.stringify([["p", blocked]]), + ); + return "cipher-nip04"; + }, + async signEvent(event) { + signedEvents.push(event); + return { ...event, id: "signed-nip04-block-event" }; + }, + }); + + manager.blockedPubkeys = new Set([blocked]); + manager.publishMuteListSnapshot = async () => null; + manager.loadBlocks = async () => {}; + + try { + const result = await manager.publishBlockList(actor); + + assert.equal(result.id, "signed-nip04-block-event"); + assert.ok( + encryptCalls.nip44 >= 1, + "nip44Encrypt should be attempted before falling back", + ); + assert.equal(encryptCalls.nip04, 1, "nip04Encrypt should handle fallback"); + const encryptedTags = signedEvents[0].tags.filter((tag) => tag[0] === "encrypted"); + assert.deepEqual( + encryptedTags, + [["encrypted", "nip04"]], + "fallback nip04 encryption should advertise nip04", + ); + assert.equal(publishCalls.length, 1, "event should publish to the available relay"); + } finally { + nostrClient.relays = originalRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + setActiveSigner(originalSigner); + } +})(); + +await (async () => { + const actor = "5".repeat(64); + const blocked = "6".repeat(64); + + const UserBlockListManager = userBlocks.constructor; + const manager = new UserBlockListManager(); + + const originalNostr = window.nostr; + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalPool = nostrClient.pool; + const originalEnsurePermissions = nostrClient.ensureExtensionPermissions; + const originalSigner = getActiveSigner(); + + clearActiveSigner(); + + const relayUrls = ["wss://relay-nip44-read.example"]; + nostrClient.relays = relayUrls; + nostrClient.ensureExtensionPermissions = async () => ({ ok: true }); + + const decryptCalls = { nip44: 0, nip04: 0 }; + window.nostr = { + nip04: { + async decrypt() { + decryptCalls.nip04 += 1; + return JSON.stringify({ blockedPubkeys: [blocked] }); + }, + }, + nip44: { + v2: { + async decrypt(_pubkey, ciphertext) { + decryptCalls.nip44 += 1; + return JSON.stringify([["p", blocked, ciphertext]]); + }, + }, + }, + }; + + nostrClient.pool = { + list() { + return Promise.resolve([ + { + id: "event-nip44-read", + kind: 10000, + created_at: 9_000, + pubkey: actor, + content: "cipher-nip44-read", + tags: [["encrypted", "nip44_v2"]], + }, + ]); + }, + }; + + try { + await manager.loadBlocks(actor); + + assert.equal(decryptCalls.nip44, 1, "nip44 decryptor should be preferred"); + assert.equal(decryptCalls.nip04, 0, "nip04 decryptor should not be used"); + } finally { + window.nostr = originalNostr; + nostrClient.relays = originalRelays; + nostrClient.pool = originalPool; + nostrClient.ensureExtensionPermissions = originalEnsurePermissions; + if (originalSigner) { + setActiveSigner(originalSigner); + } else { + clearActiveSigner(); + } + } +})(); + +await (async () => { + const actor = "7".repeat(64); + const validOne = "8".repeat(64); + const validTwoUpper = "ABCDEF01".repeat(8); + const validTwo = validTwoUpper.toLowerCase(); + + const UserBlockListManager = userBlocks.constructor; + const manager = new UserBlockListManager(); + + const originalRelays = Array.isArray(nostrClient.relays) + ? [...nostrClient.relays] + : nostrClient.relays; + const originalPool = nostrClient.pool; + const originalSigner = getActiveSigner(); + const originalStderrWrite = process.stderr.write.bind(process.stderr); + + const publishCalls = []; + const encryptionCalls = []; + const signedEvents = []; + const stderrChunks = []; + + process.stderr.write = (chunk, encoding, callback) => { + const text = + typeof chunk === "string" + ? chunk + : Buffer.from(chunk, typeof encoding === "string" ? encoding : undefined).toString(); + stderrChunks.push(text); + if (typeof callback === "function") { + callback(); + } + return true; + }; + + nostrClient.relays = ["wss://sanitize-blocks.example"]; + nostrClient.pool = { + publish(urls, event) { + publishCalls.push({ urls, event }); + return { + on(eventName, handler) { + if (eventName === "ok") { + handler(); + return true; + } + return false; + }, + }; + }, + }; + + setActiveSigner({ + type: "nsec", + pubkey: actor, + async nip44Encrypt(pubkey, plaintext) { + encryptionCalls.push({ pubkey, plaintext }); + return `cipher-${encryptionCalls.length}`; + }, + async signEvent(event) { + signedEvents.push(event); + return { ...event, id: `signed-${signedEvents.length}`, created_at: event.created_at }; + }, + }); + + manager.blockedPubkeys = new Set([ + validOne, + validTwoUpper, + actor, + ["p", ` ${validTwoUpper} `], + ["p"], + ["p", null], + "", + ["e", validOne], + null, + ]); + manager.loadBlocks = async () => {}; + + try { + await manager.publishBlockList(actor); + + assert.equal(publishCalls.length, 2, "block and mute events should publish"); + assert.equal(encryptionCalls.length, 2, "both block and mute payloads should encrypt"); + + const [blockPayload, mutePayload] = encryptionCalls; + assert.equal(blockPayload.pubkey, actor, "block payload should encrypt for the actor"); + assert.equal(mutePayload.pubkey, actor, "mute payload should encrypt for the actor"); + + const matrix = JSON.parse(blockPayload.plaintext); + assert.deepEqual( + matrix, + [ + ["p", validOne], + ["p", validTwo], + ], + "block payload should serialize only sanitized mute tags", + ); + assert.equal( + mutePayload.plaintext, + blockPayload.plaintext, + "mute payload should reuse the sanitized block payload", + ); + + const muteEvent = signedEvents.find((event) => + Array.isArray(event?.tags) && event.tags.some((tag) => Array.isArray(tag) && tag[0] === "p"), + ); + assert(muteEvent, "mute list snapshot should include public p tags"); + const muteTags = muteEvent.tags.filter((tag) => Array.isArray(tag) && tag[0] === "p"); + assert.deepEqual( + muteTags, + matrix, + "mute list snapshot should publish sanitized p tags", + ); + + const expectedReasons = [ + "self-target", + "duplicate", + "invalid-tuple", + "invalid-target", + "invalid-string", + "unsupported-tag", + "unsupported-entry", + ].sort(); + + const warningLines = stderrChunks + .join("") + .split(/\n+/) + .filter((line) => line.includes("[UserBlockList] Discarded block entry")); + + assert.equal( + warningLines.length, + expectedReasons.length, + "every malformed entry should trigger a warning", + ); + + const actualReasons = warningLines + .map((line) => { + const match = line.match(/\(([^)]+)\)/); + return match ? match[1] : null; + }) + .filter(Boolean) + .sort(); + + assert.deepEqual( + actualReasons, + expectedReasons, + "discarded entries should log their discard reasons", + ); + } finally { + process.stderr.write = originalStderrWrite; + nostrClient.relays = originalRelays; + nostrClient.pool = originalPool; + if (originalSigner) { + setActiveSigner(originalSigner); + } else { + clearActiveSigner(); + } + } +})(); diff --git a/tests/video-modal-comments.test.mjs b/tests/video-modal-comments.test.mjs index ce666ffd..1888dd76 100644 --- a/tests/video-modal-comments.test.mjs +++ b/tests/video-modal-comments.test.mjs @@ -2,6 +2,8 @@ import test from "node:test"; import assert from "node:assert/strict"; import { setupModal } from "./video-modal-accessibility.test.mjs"; +import VideoModalCommentController from "../js/ui/videoModalCommentController.js"; +import { COMMENT_EVENT_KIND } from "../js/nostr/commentEvents.js"; const FOCUSABLE_SELECTOR = [ "a[href]", @@ -24,6 +26,17 @@ function createCommentEvent({ id, pubkey, content, createdAt, parentId = null }) if (parentId) { tags.push(["e", parentId]); } + assert.ok( + tags.some((tag) => Array.isArray(tag) && tag[0] === "e" && tag[1] === "video123"), + "comment fixture should include root #e tag", + ); + assert.ok( + tags.some( + (tag) => + Array.isArray(tag) && tag[0] === "a" && tag[1] === "30078:authorpk:video-root", + ), + "comment fixture should include root #a tag", + ); return { id, pubkey, @@ -174,6 +187,399 @@ test("VideoModal comment composer updates messaging and dispatches events", asyn assert.strictEqual(submitDetail.triggerElement, modal.commentsSubmitButton); }); +test( + "VideoModalCommentController load preserves current video for submissions", + async () => { + const publishCalls = []; + + const controller = new VideoModalCommentController({ + commentThreadService: { + setCallbacks: () => {}, + teardown: () => {}, + defaultLimit: 10, + loadThread: () => Promise.resolve(), + processIncomingEvent: () => {}, + }, + videoModal: { + setCommentSectionCallbacks: () => {}, + hideCommentsDisabledMessage: () => {}, + showCommentsDisabledMessage: () => {}, + setCommentsVisibility: () => {}, + clearComments: () => {}, + resetCommentComposer: () => {}, + setCommentStatus: () => {}, + setCommentComposerState: () => {}, + }, + auth: { + isLoggedIn: () => true, + }, + services: { + publishComment: async (payload) => { + publishCalls.push(payload); + return { ok: true, event: { id: "comment", tags: [] } }; + }, + }, + utils: { + normalizeHexPubkey: (value) => value, + }, + }); + + const video = { + id: "video123", + pubkey: "AUTHORPK", + enableComments: true, + kind: 30078, + tags: [["d", "video-root"]], + }; + + controller.load(video); + controller.submit({ text: "Nice" }); + + await controller.modalCommentPublishPromise; + + assert.equal(publishCalls.length, 1, "publishComment should be called once"); + const payload = publishCalls[0]; + assert.equal(payload.videoEventId, "video123"); + assert.equal(payload.videoAuthorPubkey, "AUTHORPK"); + assert.equal(payload.videoDefinitionAddress, "30078:AUTHORPK:video-root"); + }, +); + +test( + "VideoModalCommentController falls back to thread pointer when video tags are absent", + async () => { + const publishCalls = []; + + const controller = new VideoModalCommentController({ + commentThreadService: { + setCallbacks: () => {}, + teardown: () => {}, + defaultLimit: 10, + loadThread: () => Promise.resolve(), + processIncomingEvent: () => {}, + }, + videoModal: { + setCommentSectionCallbacks: () => {}, + hideCommentsDisabledMessage: () => {}, + showCommentsDisabledMessage: () => {}, + setCommentsVisibility: () => {}, + clearComments: () => {}, + resetCommentComposer: () => {}, + setCommentStatus: () => {}, + setCommentComposerState: () => {}, + }, + auth: { + isLoggedIn: () => true, + }, + services: { + publishComment: async (payload) => { + publishCalls.push(payload); + return { ok: true, event: { id: "comment", tags: [] } }; + }, + }, + utils: { + normalizeHexPubkey: (value) => value, + }, + }); + + const video = { + id: "video456", + pubkey: "AUTHORPK", + enableComments: true, + kind: 30078, + // No tags provided; buildVideoAddressPointer should return an empty string. + }; + + controller.load(video); + controller.modalCommentState.videoDefinitionAddress = + " 30078:AUTHORPK:video-root "; + + controller.submit({ text: "Fallback pointer" }); + + await controller.modalCommentPublishPromise; + + assert.equal(publishCalls.length, 1); + const payload = publishCalls[0]; + assert.equal( + payload.videoDefinitionAddress, + "30078:AUTHORPK:video-root", + "publish payload should reuse pointer from the loaded thread", + ); + }, +); + +test( + "VideoModalCommentController publishes comment using event id fallback", + async () => { + const publishCalls = []; + const statusMessages = []; + let resetCalled = false; + const composerStates = []; + const appendedEvents = []; + + const videoModal = { + setCommentComposerState: (state) => { + composerStates.push({ ...state }); + }, + resetCommentComposer: () => { + resetCalled = true; + }, + setCommentStatus: (message) => { + statusMessages.push(message); + }, + appendComment: (event) => { + appendedEvents.push(event); + }, + }; + + const processedEvents = []; + + const controller = new VideoModalCommentController({ + commentThreadService: { + setCallbacks: () => {}, + processIncomingEvent: (event) => { + processedEvents.push(event); + }, + }, + videoModal, + auth: { + isLoggedIn: () => true, + }, + services: { + publishComment: async (payload, eventData) => { + publishCalls.push([payload, eventData]); + return { + ok: true, + event: { + id: "legacy-comment", + pubkey: "pk1", + content: eventData.content, + tags: [], + }, + }; + }, + }, + utils: { + normalizeHexPubkey: (value) => value?.toLowerCase?.() || value, + }, + }); + + controller.currentVideo = { + id: "legacy-video", + pubkey: "AUTHORPK", + enableComments: true, + kind: 30078, + tags: [], + }; + controller.modalCommentState.videoEventId = "legacy-video"; + + await controller.handleVideoModalCommentSubmit({ text: "Legacy support" }); + + assert.equal(publishCalls.length, 1, "publishComment should be invoked"); + const [payload, eventData] = publishCalls[0]; + assert.deepStrictEqual(payload, { + videoEventId: "legacy-video", + parentCommentId: null, + videoKind: "30078", + videoAuthorPubkey: "AUTHORPK", + rootKind: "30078", + rootAuthorPubkey: "AUTHORPK", + }); + assert.equal( + "videoDefinitionAddress" in payload, + false, + "payload should omit videoDefinitionAddress when unavailable", + ); + assert.equal(eventData.content, "Legacy support"); + + assert.equal(processedEvents.length, 1, "event should be processed optimistically"); + assert.equal(resetCalled, true, "composer should reset after publishing"); + assert.ok( + statusMessages.includes("Comment posted."), + "success message should be surfaced", + ); + assert.equal( + composerStates[composerStates.length - 1]?.disabled, + false, + "composer should be re-enabled after publishing", + ); + assert.equal(appendedEvents.length, 0, "optimistic insert should avoid duplicate append"); + }, +); + +test( + "VideoModalCommentController prompts login when publish requires authentication", + async () => { + const composerStates = []; + const loginLifecycle = []; + const errorMessages = []; + + const loginModal = { + openModal: ({ triggerElement } = {}) => { + loginLifecycle.push({ type: "openModal", triggerElement }); + return true; + }, + }; + + const controller = new VideoModalCommentController({ + commentThreadService: { + setCallbacks: () => {}, + processIncomingEvent: () => {}, + }, + videoModal: { + setCommentComposerState: (state) => { + composerStates.push({ ...state }); + }, + resetCommentComposer: () => { + throw new Error("composer should not reset when auth is required"); + }, + setCommentStatus: () => {}, + appendComment: () => {}, + }, + auth: { + isLoggedIn: () => true, + initializeLoginModalController: ({ logIfMissing }) => { + loginLifecycle.push({ type: "initialize", logIfMissing }); + }, + getLoginModalController: () => loginModal, + requestLogin: ({ allowAccountSelection }) => { + loginLifecycle.push({ type: "request", allowAccountSelection }); + return Promise.resolve(true); + }, + }, + callbacks: { + showError: (message) => { + errorMessages.push(message); + }, + showStatus: () => {}, + muteAuthor: () => Promise.resolve(), + shouldHideAuthor: () => false, + }, + services: { + publishComment: async () => ({ ok: false, error: "auth-required" }), + }, + utils: { + normalizeHexPubkey: (value) => value?.toLowerCase?.() || value, + }, + }); + + controller.currentVideo = { + id: "video-auth", + pubkey: "AUTHORPK", + enableComments: true, + kind: 30078, + tags: [], + }; + controller.modalCommentState.videoEventId = "video-auth"; + controller.modalCommentState.videoKind = "30078"; + controller.modalCommentState.videoAuthorPubkey = "AUTHORPK"; + + const triggerElement = { id: "comment-trigger" }; + + await controller.handleVideoModalCommentSubmit({ + text: "Needs auth", + triggerElement, + }); + + const lastComposerState = composerStates[composerStates.length - 1]; + assert.deepStrictEqual( + lastComposerState, + { disabled: true, reason: "login-required" }, + "composer should remain disabled while prompting for login", + ); + assert.equal(errorMessages.length, 0, "auth-required should not surface as an error"); + + assert.equal( + loginLifecycle.some((step) => step.type === "initialize"), + true, + "login modal controller should be initialized", + ); + assert.equal( + loginLifecycle.some((step) => step.type === "openModal"), + true, + "login modal should attempt to open", + ); + const modalOpen = loginLifecycle.find((step) => step.type === "openModal"); + assert.equal( + modalOpen?.triggerElement, + triggerElement, + "trigger element should propagate to login modal", + ); + }, +); + +test( + "VideoModalCommentController includes parent metadata when replying", + async () => { + const publishCalls = []; + + const parentEvent = { + id: "parent-1", + kind: COMMENT_EVENT_KIND, + pubkey: "parentpk", + tags: [], + }; + + const controller = new VideoModalCommentController({ + commentThreadService: { + setCallbacks: () => {}, + getCommentEvent: (id) => (id === "parent-1" ? parentEvent : null), + processIncomingEvent: () => {}, + }, + videoModal: { + setCommentComposerState: () => {}, + setCommentStatus: () => {}, + resetCommentComposer: () => {}, + appendComment: () => {}, + }, + auth: { + isLoggedIn: () => true, + }, + services: { + publishComment: async (payload) => { + publishCalls.push(payload); + return { ok: true, event: { id: "reply", tags: [] } }; + }, + }, + utils: { + normalizeHexPubkey: (value) => value?.toLowerCase?.() || value, + }, + }); + + controller.currentVideo = { + id: "video123", + pubkey: "AUTHORPK", + enableComments: true, + kind: 30078, + }; + controller.modalCommentState = { + videoEventId: "video123", + videoDefinitionAddress: null, + videoKind: "30078", + videoAuthorPubkey: "AUTHORPK", + parentCommentId: "parent-1", + parentCommentKind: String(COMMENT_EVENT_KIND), + parentCommentPubkey: null, + }; + + await controller.handleVideoModalCommentSubmit({ + text: "Replying", + parentId: "parent-1", + }); + + assert.equal(publishCalls.length, 1, "reply should trigger publish call"); + const payload = publishCalls[0]; + assert.equal(payload.videoEventId, "video123"); + assert.equal(payload.videoKind, "30078"); + assert.equal(payload.videoAuthorPubkey, "AUTHORPK"); + assert.equal(payload.parentCommentId, "parent-1"); + assert.equal(payload.parentCommentKind, String(COMMENT_EVENT_KIND)); + assert.equal(payload.parentCommentPubkey, "parentpk"); + assert.equal(payload.parentAuthorPubkey, "parentpk"); + assert.equal(payload.rootAuthorPubkey, "AUTHORPK"); + }, +); + test("VideoModal comment section exposes aria landmarks and participates in focus trap", async (t) => { const { window, document, modal, playerModal, trigger, cleanup } = await setupModal(); t.after(cleanup); diff --git a/tests/video-modal-controllers.test.mjs b/tests/video-modal-controllers.test.mjs index b5849cdf..297bfb86 100644 --- a/tests/video-modal-controllers.test.mjs +++ b/tests/video-modal-controllers.test.mjs @@ -77,3 +77,116 @@ test("ModerationController reset clears moderation overlay references", async (t ); }); +test("VideoModal trims tag strip to fit modal width", async (t) => { + const { window, modal, cleanup } = await setupModal(); + t.after(cleanup); + + const root = modal.videoTagsRoot; + assert.ok(root, "tag container should be available after hydrate"); + + modal.setTagPreferenceStateResolver((tag) => { + if (tag === "alpha") { + return "interest"; + } + if (tag === "beta") { + return "disinterest"; + } + return "neutral"; + }); + + let containerWidth = 180; + Object.defineProperty(root, "clientWidth", { + configurable: true, + get() { + return containerWidth; + }, + }); + root.getBoundingClientRect = () => ({ width: containerWidth }); + + const elementPrototype = window.HTMLElement.prototype; + const originalScrollWidthDescriptor = + Object.getOwnPropertyDescriptor(elementPrototype, "scrollWidth") || null; + + Object.defineProperty(elementPrototype, "scrollWidth", { + configurable: true, + get() { + if (this.classList?.contains("video-tag-strip")) { + const buttonCount = this.querySelectorAll("button[data-tag]").length; + return buttonCount * 90; + } + if (originalScrollWidthDescriptor?.get) { + return originalScrollWidthDescriptor.get.call(this); + } + return 0; + }, + }); + + t.after(() => { + if (originalScrollWidthDescriptor) { + Object.defineProperty( + elementPrototype, + "scrollWidth", + originalScrollWidthDescriptor, + ); + } else { + delete elementPrototype.scrollWidth; + } + delete root.clientWidth; + delete root.getBoundingClientRect; + }); + + modal.renderVideoTags(["gamma", "beta", "delta", "alpha"]); + + const trimmedButtons = [ + ...root.querySelectorAll("button[data-tag]"), + ]; + assert.equal(trimmedButtons.length, 2, "tag list should be trimmed to fit"); + assert.deepEqual( + trimmedButtons.map((button) => button.dataset.tag), + ["alpha", "beta"], + "leading tags should remain after trimming", + ); + assert.equal( + trimmedButtons[0].dataset.preferenceState, + "interest", + "interest styling should persist on trimmed buttons", + ); + assert.equal( + trimmedButtons[0].dataset.variant, + "success", + "interest variant token should remain on trimmed buttons", + ); + assert.equal( + trimmedButtons[1].dataset.preferenceState, + "disinterest", + "disinterest styling should persist on trimmed buttons", + ); + assert.equal( + trimmedButtons[1].dataset.variant, + "critical", + "disinterest variant token should remain on trimmed buttons", + ); + assert.equal( + root.hasAttribute("hidden"), + false, + "tag container should stay visible when pills remain", + ); + + containerWidth = 300; + modal.reflowVideoTags(); + + const expandedButtons = [ + ...root.querySelectorAll("button[data-tag]"), + ]; + assert.equal( + expandedButtons.length, + 3, + "reflow should allow more tags when width increases", + ); + assert.deepEqual( + expandedButtons.map((button) => button.dataset.tag), + ["alpha", "beta", "delta"], + "reflow should restore full list order before trimming", + ); +}); + diff --git a/tests/video-modal-zap.test.mjs b/tests/video-modal-zap.test.mjs index bd21c978..1011fb1c 100644 --- a/tests/video-modal-zap.test.mjs +++ b/tests/video-modal-zap.test.mjs @@ -303,6 +303,23 @@ async function createApp({ splitAndZap }) { }, }); + app.boundVideoModalZapOpenHandler = (event = {}) => { + const requiresLogin = Boolean(event?.detail?.requiresLogin); + app.pendingModalZapOpen = requiresLogin; + + const openResult = app.zapController?.open({ requiresLogin }); + if (!openResult) { + event?.preventDefault?.(); + if (!requiresLogin) { + app.pendingModalZapOpen = false; + } + modalStub.closeZapDialog?.({ silent: true, restoreFocus: false }); + return; + } + + app.pendingModalZapOpen = false; + }; + const creatorAddress = "creator@example.com"; const platformAddress = "platform@example.com"; setCachedPlatformLightningAddress(platformAddress); @@ -420,6 +437,9 @@ await (async () => { nostrClient.sessionActor = { pubkey: sessionPubkey, privateKey: "priv" }; app.pubkey = sessionPubkey; + app.isUserLoggedIn = () => false; + app.zapController.isUserLoggedIn = () => false; + app.zapController.hasSessionActor = () => true; modalStub.zapVisibilityCalls = []; app.zapController.setVisibility(true); @@ -485,9 +505,14 @@ await (async () => { receipts: [ { recipientType: "creator", + status: "success", amount: payload.amountSats, address: payload.videoEvent.lightningAddress, payment: { result: { preimage: "ff".repeat(16) } }, + validation: { + status: "passed", + event: { kind: 9735, id: "creator-receipt" }, + }, }, ], }; @@ -543,4 +568,414 @@ await (async () => { app.destroy(); })(); +await (async () => { + // Test: validation skipped receipts do not trigger warnings + const receipts = [ + { + recipientType: "creator", + status: "success", + amount: 600, + address: "creator@example.com", + payment: { result: { preimage: "dd".repeat(16) } }, + validation: { + status: "skipped", + reason: "Zap request unavailable", + }, + }, + { + recipientType: "platform", + status: "success", + amount: 100, + address: "platform@example.com", + validation: { + status: "skipped", + reason: "Zap request unavailable", + }, + }, + ]; + + const { app, modalStub, creatorAddress } = await createApp({ + splitAndZap: async () => ({ receipts }), + }); + + const pubkeyHex = "d".repeat(64); + app.pubkey = pubkeyHex; + const normalized = app.normalizeHexPubkey(pubkeyHex); + app.nwcSettingsService.cache.set(normalized, { + nwcUri: "nostr+walletconnect://example", + defaultZap: null, + lastChecked: null, + version: "", + }); + + app.currentVideo = { + id: "event901", + pubkey: pubkeyHex, + tags: [["d", "video901"]], + content: "", + created_at: 1_700_000_150, + lightningAddress: creatorAddress, + }; + + const initialWarningCount = modalStub.statusMessages.filter( + (entry) => entry.tone === "warning" + ).length; + + await app.zapController.sendZap({ amount: 700, comment: "No receipt support" }); + + const warningsAfter = modalStub.statusMessages.filter( + (entry) => entry.tone === "warning" + ).length; + assert.equal( + warningsAfter, + initialWarningCount, + "skipped validation should not emit new warnings", + ); + + const lastStatus = modalStub.statusMessages[modalStub.statusMessages.length - 1]; + assert.equal(lastStatus.tone, "success", "zap should report success when validation skipped"); + assert(!/awaiting validated zap receipt/i.test(lastStatus.message)); + + const lastReceiptEntry = modalStub.receipts[modalStub.receipts.length - 1]; + assert.equal( + lastReceiptEntry?.options?.partial, + false, + "receipt rendering should complete when validation is skipped", + ); + + app.destroy(); +})(); + +await (async () => { + // Test: platform receipt failure keeps retry state active and surfaces warning + const platformError = new Error("Budget exceeded"); + const receipts = [ + { + recipientType: "creator", + status: "success", + amount: 900, + address: "creator@example.com", + payment: { result: { preimage: "cc".repeat(16) } }, + validation: { + status: "passed", + event: { kind: 9735, id: "creator-receipt" }, + }, + }, + { + recipientType: "platform", + status: "error", + amount: 100, + address: "platform@example.com", + error: platformError, + }, + ]; + + const { app, modalStub, creatorAddress, platformAddress } = await createApp({ + splitAndZap: async () => ({ receipts }), + }); + + const pubkeyHex = "c".repeat(64); + app.pubkey = pubkeyHex; + const normalized = app.normalizeHexPubkey(pubkeyHex); + app.nwcSettingsService.cache.set(normalized, { + nwcUri: "nostr+walletconnect://example", + defaultZap: null, + lastChecked: null, + version: "", + }); + + app.currentVideo = { + id: "event789", + pubkey: pubkeyHex, + tags: [["d", "video789"]], + content: "", + created_at: 1_700_000_100, + lightningAddress: creatorAddress, + }; + + const initialResetCount = modalStub.resetForms.length; + const initialCompletedCount = modalStub.completedStates.length; + + await app.zapController.sendZap({ amount: 1000, comment: "Nice work" }); + + const lastReceiptEntry = modalStub.receipts[modalStub.receipts.length - 1]; + assert.equal( + lastReceiptEntry.options?.partial, + true, + "should render zap receipts in partial mode when failures occur", + ); + + assert.equal( + app.zapController.modalZapRetryState?.shares?.length, + 1, + "controller should queue failing receipt for retry", + ); + assert.equal( + modalStub.retryState?.pending, + true, + "modal should display retry pending state for failed share", + ); + + const lastStatus = modalStub.statusMessages[modalStub.statusMessages.length - 1]; + assert.equal(lastStatus.tone, "warning", "warning tone should be emitted for receipt failure"); + assert.ok( + /increase your wallet zap limit or reduce the platform fee/i.test(lastStatus.message), + "status message should translate budget exceeded guidance", + ); + assert.ok( + /Remaining share\(s\): Platform 100 sats\./.test(lastStatus.message), + "status message should summarize remaining platform share", + ); + + assert.equal( + modalStub.resetForms.length, + initialResetCount, + "zap form should not reset while a share remains unpaid", + ); + assert.equal( + modalStub.completedStates.length, + initialCompletedCount + 1, + "zap completion calls should only reflect the in-flight attempt", + ); + assert.equal( + modalStub.completedStates[modalStub.completedStates.length - 1], + false, + "zap modal should not mark zap as completed on partial failure", + ); + assert.equal( + app.zapController.modalZapCommentValue, + "Nice work", + "zap controller should retain comment value for retry", + ); + + // Ensure platform retry summary references the expected address context + assert.equal( + app.zapController.modalZapRetryState?.shares?.[0]?.type, + "platform", + "retry state should track platform share type", + ); + assert.equal( + app.zapController.modalZapRetryState?.shares?.[0]?.amount, + 100, + "retry state should preserve remaining platform amount", + ); + + app.destroy(); +})(); + +await (async () => { + // Test: validation failure surfaces warning and resets form + const validationReceipts = [ + { + recipientType: "creator", + status: "success", + amount: 750, + address: "creator@example.com", + payment: { result: { preimage: "dd".repeat(16) } }, + validation: { + status: "failed", + reason: "No compliant receipt published", + }, + }, + ]; + + const { app, modalStub, creatorAddress } = await createApp({ + splitAndZap: async () => ({ receipts: validationReceipts }), + }); + + const pubkeyHex = "d".repeat(64); + app.pubkey = pubkeyHex; + const normalized = app.normalizeHexPubkey(pubkeyHex); + app.nwcSettingsService.cache.set(normalized, { + nwcUri: "nostr+walletconnect://example", + defaultZap: null, + lastChecked: null, + version: "", + }); + + app.currentVideo = { + id: "event990", + pubkey: pubkeyHex, + tags: [["d", "video990"]], + content: "", + created_at: 1_700_000_200, + lightningAddress: creatorAddress, + }; + + const initialResetCount = modalStub.resetForms.length; + const initialCompleted = modalStub.completedStates.length; + + await app.zapController.sendZap({ amount: 750, comment: "Pending receipt" }); + + const lastReceiptEntry = modalStub.receipts[modalStub.receipts.length - 1]; + assert.equal( + lastReceiptEntry.options?.partial, + true, + "should render zap receipts in partial mode for validation issues", + ); + + const lastStatus = modalStub.statusMessages[modalStub.statusMessages.length - 1]; + assert.equal(lastStatus.tone, "warning", "validation failure should emit warning status"); + assert.match( + lastStatus.message, + /awaiting validated zap receipt/i, + "status message should highlight missing validated receipt", + ); + + assert.equal( + modalStub.resetForms.length, + initialResetCount + 1, + "zap form should reset after validation warning", + ); + assert.equal( + modalStub.completedStates.length, + initialCompleted + 1, + "completion state should record the validation attempt", + ); + assert.equal( + modalStub.completedStates[modalStub.completedStates.length - 1], + true, + "validation warning should mark zap attempt as completed", + ); + + app.destroy(); +})(); + +await (async () => { + // Test: allowance exhaustion surfaces guidance and skips retry queue + const { app, modalStub, creatorAddress, platformAddress } = await createApp({ + splitAndZap: async () => ({ receipts: [] }), + }); + + const shareError = new Error("Budget exceeded"); + const tracker = [ + { + type: "creator", + status: "success", + amount: 900, + address: creatorAddress, + payment: { preimage: "aa".repeat(16) }, + validation: { + status: "passed", + event: { kind: 9735, id: "creator-receipt" }, + }, + }, + { + type: "platform", + status: "error", + amount: 100, + address: platformAddress, + error: shareError, + }, + ]; + + const walletError = new Error("Budget exceeded"); + walletError.__zapShareTracker = tracker; + + modalStub.statusMessages = []; + modalStub.retryState = undefined; + + app.zapController.handleZapError({ + error: walletError, + amount: 1000, + comment: "", + walletSettings: { nwcUri: "nostr+walletconnect://example" }, + }); + + const lastStatus = + modalStub.statusMessages[modalStub.statusMessages.length - 1]; + assert.ok(lastStatus, "status message should be recorded"); + assert.equal( + lastStatus.tone, + "warning", + "partial allowance exhaustion should produce a warning tone", + ); + assert.ok( + /zap allowance/i.test(lastStatus.message), + "status message should mention zap allowance exhaustion", + ); + assert.ok( + /increase your wallet zap limit or reduce the platform split/i.test( + lastStatus.message, + ), + "status message should advise adjusting allowance or platform split", + ); + assert.equal( + lastStatus.message.includes("Press Send again"), + false, + "allowance exhaustion should not prompt a retry", + ); + assert.equal( + app.zapController.modalZapRetryState, + null, + "controller should clear retry state when allowance exhausted", + ); + assert.equal( + modalStub.retryState?.pending, + false, + "modal should not mark retry pending when allowance exhausted", + ); + + app.destroy(); +})(); + +const { VideoModal } = await import("../js/ui/components/VideoModal.js"); + +(() => { + const modal = new VideoModal({ document: documentStub, setGlobalModalState: noop }); + modal.modalZapReceipts = new DummyElement(); + + const receipts = [ + { + recipientType: "creator", + amount: 600, + address: "creator@example.com", + payment: { result: { preimage: "aa".repeat(16) } }, + validation: { + status: "passed", + event: { kind: 9735, id: "validated" }, + }, + }, + ]; + + modal.renderZapReceipts(receipts, { partial: false }); + + assert.equal(modal.modalZapReceipts.children.length, 1, "validated receipt should render one entry"); + const entry = modal.modalZapReceipts.children[0]; + const header = entry.children[0]; + assert.equal(header.children[1].textContent, "Validated", "validated receipt should flag status"); +})(); + +(() => { + const modal = new VideoModal({ document: documentStub, setGlobalModalState: noop }); + modal.modalZapReceipts = new DummyElement(); + + const receipts = [ + { + recipientType: "creator", + amount: 450, + address: "creator@example.com", + payment: { result: { preimage: "bb".repeat(16) } }, + validation: { + status: "failed", + reason: "No compliant receipt", + }, + }, + ]; + + modal.renderZapReceipts(receipts, { partial: true }); + + assert.equal( + modal.modalZapReceipts.children.length, + 1, + "validation failure should render a single warning entry", + ); + const warning = modal.modalZapReceipts.children[0]; + assert.match( + warning.textContent, + /no validated zap receipts yet/i, + "warning message should note missing validated receipts", + ); +})(); + process.exit(0); diff --git a/tests/video-note-payload.test.mjs b/tests/video-note-payload.test.mjs index 25b4adac..d8c3c904 100644 --- a/tests/video-note-payload.test.mjs +++ b/tests/video-note-payload.test.mjs @@ -81,6 +81,8 @@ test("normalizes nip71 metadata collections", () => { imeta: [ { url: " https://cdn.example.com/hls/playlist.m3u8 ", + duration: " 120.5 ", + bitrate: " 2100000 ", service: [" wss://relay.example.com "], }, ], @@ -144,6 +146,26 @@ test("normalizes nip71 metadata collections", () => { ]); assert.equal(nip71.imeta[0].url, "https://cdn.example.com/hls/playlist.m3u8"); assert.deepEqual(nip71.imeta[0].service, ["wss://relay.example.com"]); + assert.equal(nip71.imeta[0].duration, 120.5); + assert.equal(nip71.imeta[0].bitrate, 2100000); +}); + +test("derives legacy duration fallback from imeta variants", () => { + const { payload, errors } = normalizeVideoNotePayload({ + title: "Duration Fallback", + nip71: { + imeta: [ + { url: "https://cdn.example.com/a.mp4", duration: 12.5 }, + { url: "https://cdn.example.com/b.mp4", duration: "45.75" }, + ], + }, + }); + + assert.deepEqual(errors, []); + assert.ok(payload.nip71, "Expected nip71 payload"); + assert.equal(payload.nip71.duration, 45.75); + assert.equal(payload.nip71.imeta[0].duration, 12.5); + assert.equal(payload.nip71.imeta[1].duration, 45.75); }); test("reports validation errors for missing fields", () => { diff --git a/tests/view-counter.test.mjs b/tests/view-counter.test.mjs index d0f68408..9c5d2356 100644 --- a/tests/view-counter.test.mjs +++ b/tests/view-counter.test.mjs @@ -10,10 +10,6 @@ const { VIEW_COUNT_CACHE_TTL_MS, } = await import("../js/config.js"); -const { buildViewEvent, setNostrEventSchemaOverrides } = await import( - "../js/nostrEventSchemas.js" -); - const VIEW_COUNTER_STORAGE_KEY = "bitvid:view-counter:v1"; const CACHE_TTL_TEST_POINTER = { type: "e", value: "view-counter-cache-ttl" }; @@ -47,6 +43,19 @@ if (!globalThis.window.NostrTools) { globalThis.window.NostrTools = {}; } +const VIEW_SANITIZED_SAMPLE_HEX = "deadbeef".repeat(8); +const existingNip19Decoder = + typeof globalThis.window.NostrTools.nip19 === "object" + ? globalThis.window.NostrTools.nip19 + : {}; + +if (typeof existingNip19Decoder.decode !== "function") { + globalThis.window.NostrTools.nip19 = { + ...existingNip19Decoder, + decode: () => ({ type: "npub", data: VIEW_SANITIZED_SAMPLE_HEX }), + }; +} + if (typeof globalThis.window.NostrTools.getEventHash !== "function") { globalThis.window.NostrTools.getEventHash = () => "test-event-hash"; } @@ -55,6 +64,10 @@ if (typeof globalThis.window.NostrTools.signEvent !== "function") { globalThis.window.NostrTools.signEvent = () => "test-event-sig"; } +const { buildViewEvent, setNostrEventSchemaOverrides } = await import( + "../js/nostrEventSchemas.js" +); + setNostrEventSchemaOverrides({}); const canonicalViewEvent = buildViewEvent({ @@ -93,6 +106,42 @@ assert.deepEqual( "view event should append the session tag when requested" ); +const sanitizedViewEvent = buildViewEvent({ + pubkey: "actor-sanitize", + created_at: 3000, + pointerValue: "event-sanitize", + pointerTag: ["e", "event-sanitize"], + additionalTags: [ + ["p", null], + ["p", "npub1viewadditionaltagfixture000000000000000000000"], + ["client", { foo: "bar" }], + ["client", "bitvid"], + ], +}); + +assert.ok( + sanitizedViewEvent.tags.some( + (tag) => Array.isArray(tag) && tag[0] === "p" && tag[1] === VIEW_SANITIZED_SAMPLE_HEX + ), + "view event should normalize npub additional tags to hex" +); + +const sanitizedClientTags = sanitizedViewEvent.tags.filter( + (tag) => Array.isArray(tag) && tag[0] === "client" +); +assert.deepEqual(sanitizedClientTags, [["client", "bitvid"]]); + +assert.ok( + !sanitizedViewEvent.tags.some( + (tag) => + Array.isArray(tag) && + tag[0] === "client" && + typeof tag[1] === "string" && + tag[1].includes("[object Object]") + ), + "invalid additional tag values should not be coerced to object strings" +); + const { nostrClient } = await import("../js/nostr.js"); function createMockNostrHarness() { diff --git a/tests/watch-history.test.mjs b/tests/watch-history.test.mjs index 5f6559e5..ba4baaec 100644 --- a/tests/watch-history.test.mjs +++ b/tests/watch-history.test.mjs @@ -316,6 +316,32 @@ async function installSessionCrypto({ privateKey }) { const { createHash, randomBytes } = await import("node:crypto"); const deriveHex = (input) => createHash("sha256").update(String(input ?? ""), "utf8").digest("hex"); + const keyToHex = (value) => { + if (typeof value === "string") { + return value; + } + if (value instanceof Uint8Array || Array.isArray(value)) { + return Buffer.from(value).toString("hex"); + } + if (value && typeof value === "object" && typeof value.length === "number") { + return Buffer.from(value).toString("hex"); + } + return deriveHex(value); + }; + const encodePayload = (prefix, conversationKey, plaintext) => { + const keySegment = keyToHex(conversationKey); + const payload = Buffer.from(plaintext, "utf8").toString("base64"); + return `${prefix}:${keySegment}:${payload}`; + }; + const decodePayload = (prefix, conversationKey, ciphertext) => { + const keySegment = keyToHex(conversationKey); + const expected = `${prefix}:${keySegment}:`; + if (!ciphertext.startsWith(expected)) { + throw new Error("invalid-session-ciphertext"); + } + const encoded = ciphertext.slice(expected.length); + return Buffer.from(encoded, "base64").toString("utf8"); + }; const previousEnsure = nostrClient.watchHistory?.deps?.ensureNostrTools || null; const previousGetCached = @@ -350,6 +376,40 @@ async function installSessionCrypto({ privateKey }) { return Buffer.from(encoded, "base64").toString("utf8"); }, }, + nip44: { + ...(original.nip44 || {}), + encrypt: (plaintext, conversationKey) => { + encryptCalls += 1; + return encodePayload("session44-legacy", conversationKey, plaintext); + }, + decrypt: (ciphertext, conversationKey) => { + decryptCalls += 1; + return decodePayload("session44-legacy", conversationKey, ciphertext); + }, + getConversationKey: (privBytes, target) => + `${keyToHex(privBytes)}:${target}:legacy`, + utils: { + ...(original.nip44?.utils || {}), + getConversationKey: (privBytes, target) => + `${keyToHex(privBytes)}:${target}:legacy-utils`, + }, + v2: { + ...(original.nip44?.v2 || {}), + encrypt: (plaintext, conversationKey) => { + encryptCalls += 1; + return encodePayload("session44", conversationKey, plaintext); + }, + decrypt: (ciphertext, conversationKey) => { + decryptCalls += 1; + return decodePayload("session44", conversationKey, ciphertext); + }, + utils: { + ...(original.nip44?.v2?.utils || {}), + getConversationKey: (privBytes, target) => + `${keyToHex(privBytes)}:${target}:v2`, + }, + }, + }, }; rememberNostrTools(window.NostrTools); globalThis.__BITVID_CANONICAL_NOSTR_TOOLS__ = window.NostrTools; @@ -376,10 +436,11 @@ async function installSessionCrypto({ privateKey }) { }, getEncryptCalls: () => encryptCalls, getDecryptCalls: () => decryptCalls, + getPrivateKey: () => privateKey, }; } -function installExtensionCrypto({ actor }) { +function installExtensionCrypto({ actor, supportsNip44 = true }) { const originalNostr = window.nostr; const originalTools = window.NostrTools || {}; let extensionEncrypts = 0; @@ -387,6 +448,18 @@ function installExtensionCrypto({ actor }) { let fallbackEncrypts = 0; const enableCalls = []; const decryptCalls = []; + const encodePayload = (prefix, target, plaintext) => { + const payload = Buffer.from(plaintext, "utf8").toString("base64"); + return `${prefix}:${target}:${payload}`; + }; + const decodePayload = (prefix, target, ciphertext) => { + const expected = `${prefix}:${target}:`; + if (!ciphertext.startsWith(expected)) { + throw new Error("invalid-extension-ciphertext"); + } + const encoded = ciphertext.slice(expected.length); + return Buffer.from(encoded, "base64").toString("utf8"); + }; window.nostr = { enable: async (options) => { enableCalls.push(options || null); @@ -400,21 +473,28 @@ function installExtensionCrypto({ actor }) { nip04: { encrypt: async (target, plaintext) => { extensionEncrypts += 1; - const payload = Buffer.from(plaintext, "utf8").toString("base64"); - return `extension:${target}:${payload}`; + return encodePayload("extension", target, plaintext); }, decrypt: async (target, ciphertext) => { extensionDecrypts += 1; - decryptCalls.push({ target, ciphertext }); - const prefix = `extension:${target}:`; - if (!ciphertext.startsWith(prefix)) { - throw new Error("invalid-extension-ciphertext"); - } - const encoded = ciphertext.slice(prefix.length); - return Buffer.from(encoded, "base64").toString("utf8"); + decryptCalls.push({ scheme: "nip04", target, ciphertext }); + return decodePayload("extension", target, ciphertext); }, }, }; + if (supportsNip44) { + window.nostr.nip44 = { + encrypt: async (target, plaintext) => { + extensionEncrypts += 1; + return encodePayload("extension44", target, plaintext); + }, + decrypt: async (target, ciphertext) => { + extensionDecrypts += 1; + decryptCalls.push({ scheme: "nip44", target, ciphertext }); + return decodePayload("extension44", target, ciphertext); + }, + }; + } window.NostrTools = { ...originalTools, nip04: { @@ -423,27 +503,24 @@ function installExtensionCrypto({ actor }) { fallbackEncrypts += 1; throw new Error("fallback-encrypt-used"); }, - decrypt: async (secret, pub, ciphertext) => { - const prefix = `session:${secret}:${pub}:`; - if (!ciphertext.startsWith(prefix)) { - throw new Error("invalid-session-ciphertext"); - } - const encoded = ciphertext.slice(prefix.length); - return Buffer.from(encoded, "base64").toString("utf8"); - }, }, }; rememberNostrTools(window.NostrTools); globalThis.__BITVID_CANONICAL_NOSTR_TOOLS__ = window.NostrTools; globalThis.nostrToolsReady = Promise.resolve(window.NostrTools); const previousSigner = getActiveSigner(); - setActiveSigner({ + const signer = { type: "extension", pubkey: actor, signEvent: window.nostr.signEvent, nip04Encrypt: window.nostr.nip04.encrypt, nip04Decrypt: window.nostr.nip04.decrypt, - }); + }; + if (supportsNip44) { + signer.nip44Encrypt = window.nostr.nip44.encrypt; + signer.nip44Decrypt = window.nostr.nip44.decrypt; + } + setActiveSigner(signer); return { restore() { if (previousSigner) { @@ -611,49 +688,19 @@ async function testFetchWatchHistoryExtensionDecryptsHexAndNpub() { const fallbackTag = ["e", "fallback-pointer"]; const fallbackItem = { type: "e", value: "fallback-pointer", watchedAt: 1_700_800_000 }; const chunkItem = { type: "e", value: "chunk-pointer", watchedAt: 1_700_800_100 }; + const chunkLegacyItem = { + type: "e", + value: "legacy-pointer", + watchedAt: 1_700_800_120, + }; const chunkPayload = JSON.stringify({ - version: 1, + version: 2, items: [chunkItem], snapshot: snapshotId, chunkIndex: 0, - totalChunks: 1, + totalChunks: 2, }); - const chunkCiphertext = `extension:${actorHex}:${Buffer.from(chunkPayload, "utf8").toString("base64")}`; - - const pointerEvent = { - id: "pointer-extension", - kind: WATCH_HISTORY_KIND, - pubkey: actorHex, - created_at: 1_700_800_000, - content: JSON.stringify({ - version: 1, - items: [fallbackItem], - snapshot: snapshotId, - chunkIndex: 0, - totalChunks: 1, - }), - tags: [ - ["d", WATCH_HISTORY_LIST_IDENTIFIER], - ["snapshot", snapshotId], - ["encrypted", "nip04"], - ["a", `${WATCH_HISTORY_KIND}:${actorHex}:${chunkIdentifier}`], - fallbackTag, - ], - }; - - const chunkEvent = { - id: "chunk-extension", - kind: WATCH_HISTORY_KIND, - pubkey: actorHex, - created_at: 1_700_800_060, - content: chunkCiphertext, - tags: [ - ["d", chunkIdentifier], - ["snapshot", snapshotId], - ["encrypted", "nip04"], - ], - }; if (!window.NostrTools || typeof window.NostrTools !== "object") { window.NostrTools = {}; @@ -686,19 +733,84 @@ async function testFetchWatchHistoryExtensionDecryptsHexAndNpub() { nostrClient.watchHistoryCache = new Map(); nostrClient.watchHistoryStorage = { version: 2, actors: {} }; - const publishEvents = async () => { + const runVariant = async (label, actorInput, pubkeyInput) => { + const sessionCrypto = await installSessionCrypto({ privateKey: `session-${label}` }); + + const sessionTools = window.NostrTools; + const legacyPayload = JSON.stringify({ + version: 2, + items: [chunkLegacyItem], + snapshot: snapshotId, + chunkIndex: 1, + totalChunks: 2, + }); + const legacyCiphertext = await sessionTools.nip04.encrypt( + sessionCrypto.getPrivateKey(), + actorHex, + legacyPayload, + ); + + const extensionCrypto = installExtensionCrypto({ actor: actorHex }); + poolHarness.reset(); poolHarness.setResolver(() => ({ ok: true })); + + const nip44Ciphertext = await window.nostr.nip44.encrypt(actorHex, chunkPayload); + + const pointerEvent = { + id: `pointer-${label}`, + kind: WATCH_HISTORY_KIND, + pubkey: actorHex, + created_at: 1_700_800_000, + content: JSON.stringify({ + version: 2, + items: [fallbackItem], + snapshot: snapshotId, + chunkIndex: 0, + totalChunks: 2, + }), + tags: [ + ["d", WATCH_HISTORY_LIST_IDENTIFIER], + ["snapshot", snapshotId], + ["encrypted", "nip44_v2"], + ["a", `${WATCH_HISTORY_KIND}:${actorHex}:${chunkIdentifier}`], + ["a", `${WATCH_HISTORY_KIND}:${actorHex}:${chunkIdentifier}-legacy`], + fallbackTag, + ], + }; + + const chunkEvent = { + id: `chunk-extension-${label}`, + kind: WATCH_HISTORY_KIND, + pubkey: actorHex, + created_at: 1_700_800_060, + content: nip44Ciphertext, + tags: [ + ["d", chunkIdentifier], + ["snapshot", snapshotId], + ["chunk", "0", "2"], + ["encrypted", "nip44_v2"], + ], + }; + + const chunkLegacyEvent = { + id: `chunk-legacy-${label}`, + kind: WATCH_HISTORY_KIND, + pubkey: actorHex, + created_at: 1_700_800_120, + content: legacyCiphertext, + tags: [ + ["d", `${chunkIdentifier}-legacy`], + ["snapshot", snapshotId], + ["chunk", "1", "2"], + ["encrypted", "nip04"], + ], + }; + poolHarness.publish(["wss://relay.test"], pointerEvent); poolHarness.publish(["wss://relay.test"], chunkEvent); + poolHarness.publish(["wss://relay.test"], chunkLegacyEvent); await new Promise((resolve) => setTimeout(resolve, 0)); - }; - - const runVariant = async (label, actorInput, pubkeyInput) => { - await publishEvents(); - - const sessionCrypto = await installSessionCrypto({ privateKey: `session-${label}` }); - const extensionCrypto = installExtensionCrypto({ actor: actorHex }); const previousEnsure = nostrClient.ensureSessionActor; const previousSession = nostrClient.sessionActor; @@ -707,10 +819,11 @@ async function testFetchWatchHistoryExtensionDecryptsHexAndNpub() { try { nostrClient.pubkey = pubkeyInput; - nostrClient.sessionActor = null; - nostrClient.ensureSessionActor = async () => { - throw new Error(`session fallback should not run for ${label}`); + nostrClient.sessionActor = { + pubkey: actorHex, + privateKey: sessionCrypto.getPrivateKey(), }; + nostrClient.ensureSessionActor = async () => actorHex; nostrClient.watchHistoryCache.clear(); nostrClient.watchHistoryStorage = { version: 2, actors: {} }; @@ -720,31 +833,46 @@ async function testFetchWatchHistoryExtensionDecryptsHexAndNpub() { assert.equal( extensionCrypto.getExtensionDecrypts(), - 1, - `${label} actor should use extension decrypt`, + 2, + `${label} actor should attempt extension decrypt for each encrypted chunk`, ); assert.equal( sessionCrypto.getDecryptCalls(), - 0, - `${label} actor should not trigger session decrypt fallback`, + 1, + `${label} actor should invoke session decrypt for nip04 fallback chunks`, ); const decryptCalls = extensionCrypto.getDecryptCalls(); assert.equal( decryptCalls.length, - 1, - `${label} actor should invoke extension decrypt exactly once`, + 2, + `${label} actor should attempt extension decrypt for both chunk schemes`, ); assert.equal( decryptCalls[0]?.target, actorHex, `${label} actor should normalize npub inputs to hex for decrypt`, ); - - assert.equal(result.items.length, 1, `${label} actor should return chunk item`); assert.equal( - result.items[0]?.value, - chunkItem.value, - `${label} actor should surface decrypted pointer value`, + decryptCalls[0]?.scheme, + "nip44", + `${label} actor should use nip44 for the first chunk`, + ); + assert.equal( + decryptCalls[1]?.scheme, + "nip04", + `${label} actor should attempt nip04 via the extension before falling back`, + ); + + assert.equal( + result.items.length, + 2, + `${label} actor should merge decrypted items from both chunks`, + ); + const values = result.items.map((item) => item?.value); + assert(values.includes(chunkItem.value), `${label} actor should include nip44 chunk item`); + assert( + values.includes(chunkLegacyItem.value), + `${label} actor should include nip04 chunk item`, ); } finally { extensionCrypto.restore(); @@ -973,14 +1101,23 @@ async function testPublishSnapshotUsesExtensionCrypto() { ); assert(extension.getExtensionEncrypts() > 0, "extension encrypt should be invoked"); - const decrypt = window.nostr?.nip04?.decrypt; + const chunkEvent = result.chunkEvents[0]; + const schemeTag = Array.isArray(chunkEvent?.tags) + ? chunkEvent.tags.find((tag) => Array.isArray(tag) && tag[0] === "encrypted") + : null; + const encryptionScheme = typeof schemeTag?.[1] === "string" ? schemeTag[1] : ""; + assert.equal(encryptionScheme, "nip44_v2", "chunk should advertise nip44_v2 encryption"); + const decrypt = + encryptionScheme === "nip44_v2" || encryptionScheme === "nip44" + ? window.nostr?.nip44?.decrypt + : window.nostr?.nip04?.decrypt; assert.equal( typeof decrypt, "function", "extension decrypt helper should be available", ); - const decrypted = await decrypt(actor, result.chunkEvents[0].content); + const decrypted = await decrypt(actor, chunkEvent.content); const payload = JSON.parse(decrypted); assert.equal(payload.snapshot, "extension"); assert.equal( @@ -988,6 +1125,12 @@ async function testPublishSnapshotUsesExtensionCrypto() { result.items.length, "decrypted payload should match canonical item count", ); + const decryptCalls = extension.getDecryptCalls(); + assert.equal( + decryptCalls[0]?.scheme, + "nip44", + "extension decrypt should prefer nip44 before falling back", + ); assert.equal( extension.getEnableCalls().length, 1, @@ -1002,6 +1145,67 @@ async function testPublishSnapshotUsesExtensionCrypto() { } } +async function testPublishSnapshotFallsBackToNip04WhenNip44Unavailable() { + poolHarness.reset(); + poolHarness.setResolver(() => ({ ok: true })); + + const actor = "ext-fallback-pubkey"; + const sessionRestore = await installSessionCrypto({ privateKey: "fallback-priv" }); + const extension = installExtensionCrypto({ actor, supportsNip44: false }); + const originalEnsure = nostrClient.ensureSessionActor; + const originalSession = nostrClient.sessionActor; + const originalPub = nostrClient.pubkey; + + try { + nostrClient.pubkey = actor; + nostrClient.sessionActor = null; + nostrClient.ensureSessionActor = async () => actor; + + const result = await nostrClient.publishWatchHistorySnapshot( + [ + { type: "e", value: "fallback-pointer-1", watchedAt: 90 }, + { type: "e", value: "fallback-pointer-2", watchedAt: 60 }, + ], + { actorPubkey: actor, snapshotId: "extension-nip04" }, + ); + + assert.ok(result.ok, "snapshot should succeed when extension lacks nip44"); + const chunkEvent = result.chunkEvents[0]; + const schemeTag = Array.isArray(chunkEvent?.tags) + ? chunkEvent.tags.find((tag) => Array.isArray(tag) && tag[0] === "encrypted") + : null; + assert.equal( + schemeTag?.[1], + "nip04", + "chunk should advertise nip04 when nip44 is unavailable", + ); + + const decrypt = window.nostr?.nip04?.decrypt; + assert.equal(typeof decrypt, "function", "nip04 decrypt helper should be available"); + const decrypted = await decrypt(actor, chunkEvent.content); + const payload = JSON.parse(decrypted); + assert.equal(payload.snapshot, "extension-nip04"); + const decryptCalls = extension.getDecryptCalls(); + assert.equal(decryptCalls.length, 1, "nip04 fallback should invoke a single decrypt attempt"); + assert.equal( + decryptCalls[0]?.scheme, + "nip04", + "extension decrypt should use nip04 when nip44 is unavailable", + ); + assert.equal( + extension.getExtensionDecrypts(), + 1, + "extension nip04 decrypt should be invoked exactly once", + ); + } finally { + extension.restore(); + sessionRestore.restore(); + nostrClient.ensureSessionActor = originalEnsure; + nostrClient.sessionActor = originalSession; + nostrClient.pubkey = originalPub; + } +} + async function testEnsureExtensionPermissionCaching() { const actor = "permission-actor"; const extension = installExtensionCrypto({ actor }); @@ -2453,6 +2657,7 @@ async function testWatchHistoryAppLoginFallback() { await testPublishSnapshotCanonicalizationAndChunking(); await testPublishSnapshotUsesExtensionCrypto(); +await testPublishSnapshotFallsBackToNip04WhenNip44Unavailable(); await testEnsureExtensionPermissionCaching(); await testFetchWatchHistoryExtensionDecryptsHexAndNpub(); await testPublishSnapshotFailureRetry(); diff --git a/tests/zap-split.test.mjs b/tests/zap-split.test.mjs index b3e2ba34..9eb95665 100644 --- a/tests/zap-split.test.mjs +++ b/tests/zap-split.test.mjs @@ -1,4 +1,5 @@ import assert from "node:assert/strict"; +import { bech32 } from "@scure/base"; if (typeof globalThis.window === "undefined") { globalThis.window = {}; @@ -76,29 +77,51 @@ globalThis.fetch = async () => { }; const { splitAndZap } = await import("../js/payments/zapSplit.js"); +const { + validateZapReceipt, + __TESTING__: validatorTesting, +} = await import("../js/payments/zapReceiptValidator.js"); const platformAddressModule = await import("../js/payments/platformAddress.js"); const { __resetPlatformAddressCache } = platformAddressModule; +const lnurlModule = await import("../js/payments/lnurl.js"); +const { + encodeLnurlBech32, + resolveLightningAddress: baseResolveLightningAddress, + requestInvoice, +} = lnurlModule; +const { decodeLnurlBech32 } = lnurlModule.__TESTING__; const { nostrClient } = await import("../js/nostr.js"); +const DEFAULT_WALLET_RELAYS = [ + "wss://wallet.primary.example", + "wss://wallet.secondary.example", + "wss://wallet.primary.example", +]; + +const BOLT11_CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l"; + function createDeps({ commentAllowed = 120, platformAddress = "platform@example.com", minSendable = 1000, maxSendable = 2_000_000, allowsNostr = true, + sendPaymentImplementation, + walletRelays = DEFAULT_WALLET_RELAYS, + validatorImplementation, } = {}) { let ensureWalletCalls = 0; const sendCalls = []; + const validatorCalls = []; return { deps: { lnurl: { resolveLightningAddress(address) { - return { - type: address.includes("platform") ? "platform" : "creator", - url: `https://lnurl.test/${address}`, - address, - }; + return { ...baseResolveLightningAddress(address) }; + }, + encodeLnurlBech32(url) { + return encodeLnurlBech32(url); }, async fetchPayServiceData(url) { const isPlatform = url.includes("platform"); @@ -121,11 +144,11 @@ function createDeps({ } return { amountMsats: amount * 1000 }; }, - async requestInvoice(metadata, { amountMsats, comment, zapRequest }) { + async requestInvoice(metadata, { amountMsats, comment, zapRequest, lnurl }) { return { invoice: `bolt11-${metadata.callback}-${amountMsats}-${comment}-${Boolean( zapRequest - )}`, + )}-${lnurl || ""}`, raw: {}, }; }, @@ -136,14 +159,26 @@ function createDeps({ return { clientPubkey: "c".repeat(64), secretKey: "1".repeat(64), + relayUrl: walletRelays[0] || null, + relayUrls: walletRelays.slice(), + relays: walletRelays.slice(), }; }, - async sendPayment(invoice, { amountSats, zapRequest }) { - sendCalls.push({ invoice, amountSats, zapRequest }); + async sendPayment(invoice, { amountSats, zapRequest, lnurl }) { + sendCalls.push({ invoice, amountSats, zapRequest, lnurl }); + if (typeof sendPaymentImplementation === "function") { + return sendPaymentImplementation({ + invoice, + amountSats, + zapRequest, + lnurl, + }); + } return { invoice, amountSats, zapRequest, + lnurl, }; }, }, @@ -152,6 +187,18 @@ function createDeps({ return platformAddress; }, }, + validator: { + async validateZapReceipt(payload) { + validatorCalls.push(payload); + if (typeof validatorImplementation === "function") { + return validatorImplementation(payload); + } + return { + status: "skipped", + reason: "Zap receipt validation is disabled in tests.", + }; + }, + }, }, getEnsureWalletCalls() { return ensureWalletCalls; @@ -159,12 +206,50 @@ function createDeps({ getSendCalls() { return sendCalls; }, + getValidatorCalls() { + return validatorCalls; + }, }; } +function buildTestBolt11Invoice({ amountCode = "10u", descriptionHashHex }) { + const hrp = `lnbc${amountCode}`; + const timestamp = 1_700_000_000; + + const timestampWords = []; + let remaining = timestamp; + for (let i = 0; i < 7; i += 1) { + timestampWords.unshift(remaining & 31); + remaining >>= 5; + } + + const words = [...timestampWords]; + + const pushTag = (tag, dataWords) => { + const code = BOLT11_CHARSET.indexOf(tag); + words.push(code); + const length = dataWords.length; + words.push((length >> 5) & 31); + words.push(length & 31); + words.push(...dataWords); + }; + + const paymentHashHex = "11".repeat(32); + pushTag("p", bech32.toWords(Buffer.from(paymentHashHex, "hex"))); + + if (descriptionHashHex) { + pushTag("h", bech32.toWords(Buffer.from(descriptionHashHex, "hex"))); + } + + const signatureWords = new Array(104).fill(0); + const data = [...words, ...signatureWords]; + + return bech32.encode(hrp, data, 2000); +} + async function testSplitMath() { globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = 10; - const { deps, getSendCalls, getEnsureWalletCalls } = createDeps(); + const { deps, getSendCalls, getEnsureWalletCalls, getValidatorCalls } = createDeps(); const videoEvent = { id: "event-id", @@ -179,11 +264,15 @@ async function testSplitMath() { deps ); + const creatorResolved = baseResolveLightningAddress(videoEvent.lightningAddress); + const platformResolved = baseResolveLightningAddress("platform@example.com"); + assert.equal(result.totalAmount, 1000); assert.equal(result.creatorShare, 900); assert.equal(result.platformShare, 100); assert.equal(result.receipts.length, 2); assert.equal(getEnsureWalletCalls(), 1); + assert.equal(getValidatorCalls().length, 2, "validator should run for each share"); const sendCalls = getSendCalls(); assert.equal(sendCalls.length, 2, "should send two payments"); @@ -192,20 +281,171 @@ async function testSplitMath() { const creatorReceipt = result.receipts[0]; assert.equal(creatorReceipt.recipientType, "creator"); + assert.equal(creatorReceipt.status, "success"); + assert.equal(creatorReceipt.validation?.status, "skipped"); assert(creatorReceipt.zapRequest, "creator zap request should be present"); const parsedZap = JSON.parse(creatorReceipt.zapRequest); assert.equal(parsedZap.kind, 9734); assert(parsedZap.tags.some((tag) => tag[0] === "amount" && tag[1] === "900000")); + const relaysTag = parsedZap.tags.find((tag) => Array.isArray(tag) && tag[0] === "relays"); + assert(relaysTag, "relays tag should be present in zap request"); + const expectedRelays = Array.from( + new Set( + DEFAULT_WALLET_RELAYS.map((relay) => + typeof relay === "string" ? relay.trim() : "" + ).filter((relay) => relay) + ) + ); + assert.deepEqual( + relaysTag.slice(1), + expectedRelays, + "relays tag should match wallet relay list" + ); + + const creatorLnurlTag = parsedZap.tags.find( + (tag) => Array.isArray(tag) && tag[0] === "lnurl" + ); + assert(creatorLnurlTag, "creator zap should include lnurl tag"); + assert.equal(creatorLnurlTag[1], creatorLnurlTag[1].toLowerCase()); + assert(creatorLnurlTag[1].startsWith("lnurl")); + assert.equal( + decodeLnurlBech32(creatorLnurlTag[1]), + creatorResolved.url + ); + + const platformReceipt = result.receipts[1]; + assert.equal(platformReceipt.recipientType, "platform"); + assert.equal(platformReceipt.status, "success"); + assert.equal(platformReceipt.validation?.status, "skipped"); + + const platformZap = JSON.parse(platformReceipt.zapRequest); + const platformLnurlTag = platformZap.tags.find( + (tag) => Array.isArray(tag) && tag[0] === "lnurl" + ); + assert(platformLnurlTag, "platform zap should include lnurl tag"); + assert.equal(platformLnurlTag[1], platformLnurlTag[1].toLowerCase()); + assert(platformLnurlTag[1].startsWith("lnurl")); + assert.equal( + decodeLnurlBech32(platformLnurlTag[1]), + platformResolved.url + ); + delete globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; } +async function testBech32LightningAddressZapTag() { + const previousOverride = globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; + globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = 0; + + const { deps } = createDeps(); + const callbackUrl = "https://lnurl.example/api/callback"; + const bech32Address = encodeLnurlBech32(callbackUrl); + + const videoEvent = { + id: "event-id", + pubkey: "c".repeat(64), + lightningAddress: bech32Address, + tags: [["d", "pointer"]], + kind: 30078, + }; + + const result = await splitAndZap({ videoEvent, amountSats: 500, comment: "Bech32" }, deps); + + assert.equal(result.platformShare, 0); + assert.equal(result.receipts.length, 1); + + const parsedZap = JSON.parse(result.receipts[0].zapRequest); + const lnurlTag = parsedZap.tags.find((tag) => Array.isArray(tag) && tag[0] === "lnurl"); + assert(lnurlTag, "bech32 address zap should include lnurl tag"); + assert.equal(lnurlTag[1], lnurlTag[1].toLowerCase()); + assert.equal(lnurlTag[1], bech32Address.toLowerCase()); + assert.equal(decodeLnurlBech32(lnurlTag[1]), callbackUrl); + + if (previousOverride === undefined) { + delete globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; + } else { + globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = previousOverride; + } +} + +async function testUrlLightningAddressZapTag() { + const previousOverride = globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; + globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = 0; + + const { deps } = createDeps(); + const directUrl = "https://direct-lnurl.example/api/pay"; + + const videoEvent = { + id: "event-id", + pubkey: "c".repeat(64), + lightningAddress: directUrl, + tags: [["d", "pointer"]], + kind: 30078, + }; + + const result = await splitAndZap({ videoEvent, amountSats: 800, comment: "Direct" }, deps); + + assert.equal(result.platformShare, 0); + assert.equal(result.receipts.length, 1); + + const parsedZap = JSON.parse(result.receipts[0].zapRequest); + const lnurlTag = parsedZap.tags.find((tag) => Array.isArray(tag) && tag[0] === "lnurl"); + assert(lnurlTag, "direct url zap should include lnurl tag"); + assert.equal(lnurlTag[1], lnurlTag[1].toLowerCase()); + assert(lnurlTag[1].startsWith("lnurl")); + assert.equal(decodeLnurlBech32(lnurlTag[1]), directUrl); + + if (previousOverride === undefined) { + delete globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; + } else { + globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = previousOverride; + } +} + +async function testRequestInvoiceIncludesLnurlParam() { + const callback = "https://callback-lnurl.example/api/pay"; + const lnurlValue = encodeLnurlBech32(callback); + const zapRequest = JSON.stringify({ kind: 9734, content: "zap" }); + const requestedUrls = []; + + const metadata = { + callback, + commentAllowed: 0, + }; + + const fetcher = async (url) => { + requestedUrls.push(url); + return { + ok: true, + async json() { + return { pr: "bolt11-invoice" }; + }, + }; + }; + + const result = await requestInvoice(metadata, { + amountMsats: 123_000, + zapRequest, + lnurl: lnurlValue, + fetcher, + }); + + assert.equal(result.invoice, "bolt11-invoice"); + assert.equal(requestedUrls.length, 1, "should call fetcher once"); + + const [url] = requestedUrls; + const parsed = new URL(url); + + assert.equal(parsed.searchParams.get("amount"), "123000"); + assert.equal(parsed.searchParams.get("nostr"), zapRequest); + assert.equal(parsed.searchParams.get("lnurl"), lnurlValue); +} + async function testWaitsForPoolBeforePlatformLookup() { const previousOverride = globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = 10; - __resetPlatformAddressCache(); - const originalEnsurePool = nostrClient.ensurePool; const originalPool = nostrClient.pool; const originalPoolPromise = nostrClient.poolPromise; @@ -252,7 +492,15 @@ async function testWaitsForPoolBeforePlatformLookup() { const deps = { lnurl: baseDeps.lnurl, wallet: baseDeps.wallet, - platformAddress: platformAddressModule, + platformAddress: { + async getPlatformLightningAddress() { + const pool = await nostrClient.ensurePool(); + if (pool && typeof pool.list === "function") { + await pool.list([], []); + } + return "platform@example.com"; + }, + }, }; const videoEvent = { @@ -323,6 +571,57 @@ async function testStringFeeOverride() { delete globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; } +async function testPlatformShareFailure() { + globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = 10; + + const platformCallbackMarker = `${ + baseResolveLightningAddress("platform@example.com").url + }/callback`; + + const { deps, getSendCalls } = createDeps({ + sendPaymentImplementation: ({ invoice, amountSats, zapRequest }) => { + if (invoice.includes(platformCallbackMarker)) { + const error = new Error("Budget exceeded"); + error.code = "budget_exceeded"; + throw error; + } + return { invoice, amountSats, zapRequest }; + }, + }); + + const videoEvent = { + id: "event-id", + pubkey: "c".repeat(64), + lightningAddress: "creator@example.com", + tags: [["d", "pointer"]], + kind: 30078, + }; + + const result = await splitAndZap( + { videoEvent, amountSats: 1000, comment: "Budget capped" }, + deps + ); + + assert.equal(result.receipts.length, 2, "should return receipts for both shares"); + + const [creatorReceipt, platformReceipt] = result.receipts; + + assert.equal(creatorReceipt.recipientType, "creator"); + assert.equal(creatorReceipt.status, "success"); + assert(creatorReceipt.payment, "creator share should still have a payment record"); + + assert.equal(platformReceipt.recipientType, "platform"); + assert.equal(platformReceipt.status, "error"); + assert.equal(platformReceipt.payment, null); + assert(platformReceipt.error instanceof Error); + assert.match(platformReceipt.error.message, /Budget exceeded/); + + const sendCalls = getSendCalls(); + assert.equal(sendCalls.length, 2, "should attempt each share exactly once"); + + delete globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__; +} + async function testLnurlBounds() { globalThis.__BITVID_PLATFORM_FEE_OVERRIDE__ = 0; const depsWrapper = createDeps({ minSendable: 5_000 }); @@ -404,11 +703,138 @@ async function testWalletFailure() { ); } +async function testValidateZapReceiptSuccess() { + const relays = ["wss://relay.validation"]; + const zapRequestEvent = { + kind: 9734, + pubkey: "f".repeat(64), + content: "", + created_at: 1_700_000_000, + tags: [ + ["p", "a".repeat(64)], + ["amount", String(900_000)], + ["relays", ...relays], + ], + }; + const zapRequestString = JSON.stringify(zapRequestEvent); + const descriptionHash = validatorTesting.computeZapRequestHash(zapRequestString); + const bolt11 = buildTestBolt11Invoice({ amountCode: "9u", descriptionHashHex: descriptionHash }); + + const receiptEvent = { + kind: 9735, + pubkey: "b".repeat(64), + tags: [ + ["bolt11", bolt11], + ["description", zapRequestString], + ], + }; + + const nostrTools = { + validateEvent: () => true, + verifyEvent: () => true, + SimplePool: class { + async list(requestedRelays, filters) { + assert.deepEqual(requestedRelays, relays); + assert.equal(filters[0]["#bolt11"][0], bolt11.toLowerCase()); + return [receiptEvent]; + } + close() {} + }, + }; + + const result = await validateZapReceipt( + { + zapRequest: zapRequestString, + amountSats: 900, + metadata: { nostrPubkey: receiptEvent.pubkey }, + invoice: { invoice: bolt11 }, + payment: { invoice: bolt11 }, + }, + { + nostrTools, + getAmountFromBolt11: () => 900, + } + ); + + assert.equal(result.status, "passed"); + assert.equal(result.event, receiptEvent); + assert.deepEqual(result.checkedRelays, relays); +} + +async function testValidateZapReceiptRejectsMismatchedDescriptionHash() { + const relays = ["wss://relay.validation"]; + const zapRequestEvent = { + kind: 9734, + pubkey: "f".repeat(64), + content: "", + created_at: 1_700_000_000, + tags: [ + ["p", "a".repeat(64)], + ["amount", String(1_000_000)], + ["relays", ...relays], + ], + }; + const zapRequestString = JSON.stringify(zapRequestEvent); + const mismatchHash = "aa".repeat(32); + const bolt11 = buildTestBolt11Invoice({ amountCode: "10u", descriptionHashHex: mismatchHash }); + + const receiptEvent = { + kind: 9735, + pubkey: "b".repeat(64), + tags: [ + ["bolt11", bolt11], + ["description", zapRequestString], + ], + }; + + const nostrTools = { + validateEvent: () => true, + verifyEvent: () => true, + SimplePool: class { + async list() { + return [receiptEvent]; + } + close() {} + }, + }; + + const result = await validateZapReceipt( + { + zapRequest: zapRequestString, + amountSats: 1_000, + metadata: { nostrPubkey: receiptEvent.pubkey }, + invoice: { invoice: bolt11 }, + payment: { invoice: bolt11 }, + }, + { + nostrTools, + getAmountFromBolt11: () => 1_000, + } + ); + + assert.equal(result.status, "failed"); + assert.match(result.reason || "", /description hash/i); +} + +function testExtractDescriptionHashFromBolt11() { + const descriptionHashHex = "bb".repeat(32); + const invoice = buildTestBolt11Invoice({ amountCode: "1m", descriptionHashHex }); + const extracted = validatorTesting.extractDescriptionHashFromBolt11(invoice); + assert.equal(extracted, descriptionHashHex); +} + await testSplitMath(); +await testBech32LightningAddressZapTag(); +await testUrlLightningAddressZapTag(); +await testRequestInvoiceIncludesLnurlParam(); await testWaitsForPoolBeforePlatformLookup(); await testLnurlBounds(); await testMissingAddress(); await testWalletFailure(); await testStringFeeOverride(); +await testPlatformShareFailure(); +await testValidateZapReceiptSuccess(); +await testValidateZapReceiptRejectsMismatchedDescriptionHash(); +testExtractDescriptionHashFromBolt11(); console.log("zap-split tests passed"); diff --git a/vendor/crypto-helpers.LICENSE b/vendor/crypto-helpers.LICENSE new file mode 100644 index 00000000..dc2bc64d --- /dev/null +++ b/vendor/crypto-helpers.LICENSE @@ -0,0 +1,22 @@ +This bundle includes code from the following MIT-licensed projects: + +- @scure/base (c) 2022 Paul Miller (https://paulmillr.com) +- @noble/hashes (c) 2022 Paul Miller (https://paulmillr.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/vendor/crypto-helpers.bundle.min.js b/vendor/crypto-helpers.bundle.min.js new file mode 100644 index 00000000..27a5a43c --- /dev/null +++ b/vendor/crypto-helpers.bundle.min.js @@ -0,0 +1,10 @@ +/* Bundled bech32 and noble hashes helpers for bitvid (MIT Licensed). Source modules: @scure/base, @noble/hashes. */ +function m(e){if(!Number.isSafeInteger(e))throw new Error(`Wrong integer: ${e}`)}function w(...e){let t=(o,s)=>i=>o(s(i)),r=Array.from(e).reverse().reduce((o,s)=>o?t(o,s.encode):s.encode,void 0),n=e.reduce((o,s)=>o?t(o,s.decode):s.decode,void 0);return{encode:r,decode:n}}function x(e){return{encode:t=>{if(!Array.isArray(t)||t.length&&typeof t[0]!="number")throw new Error("alphabet.encode input should be an array of numbers");return t.map(r=>{if(m(r),r<0||r>=e.length)throw new Error(`Digit index outside alphabet: ${r} (alphabet: ${e.length})`);return e[r]})},decode:t=>{if(!Array.isArray(t)||t.length&&typeof t[0]!="string")throw new Error("alphabet.decode input should be array of strings");return t.map(r=>{if(typeof r!="string")throw new Error(`alphabet.decode: not string element=${r}`);let n=e.indexOf(r);if(n===-1)throw new Error(`Unknown letter: "${r}". Allowed: ${e}`);return n})}}}function y(e=""){if(typeof e!="string")throw new Error("join separator should be string");return{encode:t=>{if(!Array.isArray(t)||t.length&&typeof t[0]!="string")throw new Error("join.encode input should be array of strings");for(let r of t)if(typeof r!="string")throw new Error(`join.encode: non-string input=${r}`);return t.join(e)},decode:t=>{if(typeof t!="string")throw new Error("join.decode input should be string");return t.split(e)}}}function k(e,t="="){if(m(e),typeof t!="string")throw new Error("padding chr should be string");return{encode(r){if(!Array.isArray(r)||r.length&&typeof r[0]!="string")throw new Error("padding.encode input should be array of strings");for(let n of r)if(typeof n!="string")throw new Error(`padding.encode: non-string input=${n}`);for(;r.length*e%8;)r.push(t);return r},decode(r){if(!Array.isArray(r)||r.length&&typeof r[0]!="string")throw new Error("padding.encode input should be array of strings");for(let o of r)if(typeof o!="string")throw new Error(`padding.decode: non-string input=${o}`);let n=r.length;if(n*e%8)throw new Error("Invalid padding: string should have whole number of bytes");for(;n>0&&r[n-1]===t;n--)if(!((n-1)*e%8))throw new Error("Invalid padding: string has too much padding");return r.slice(0,n)}}}function z(e){if(typeof e!="function")throw new Error("normalize fn should be function");return{encode:t=>t,decode:t=>e(t)}}function G(e,t,r){if(t<2)throw new Error(`convertRadix: wrong from=${t}, base cannot be less than 2`);if(r<2)throw new Error(`convertRadix: wrong to=${r}, base cannot be less than 2`);if(!Array.isArray(e))throw new Error("convertRadix: data should be array");if(!e.length)return[];let n=0,o=[],s=Array.from(e);for(s.forEach(i=>{if(m(i),i<0||i>=t)throw new Error(`Wrong integer: ${i}`)});;){let i=0,h=!0;for(let a=n;a<s.length;a++){let d=s[a],c=t*i+d;if(!Number.isSafeInteger(c)||t*i/t!==i||c-d!==t*i)throw new Error("convertRadix: carry overflow");if(i=c%r,s[a]=Math.floor(c/r),!Number.isSafeInteger(s[a])||s[a]*r+i!==c)throw new Error("convertRadix: carry overflow");if(h)s[a]?h=!1:n=a;else continue}if(o.push(i),h)break}for(let i=0;i<e.length-1&&e[i]===0;i++)o.push(0);return o.reverse()}var X=(e,t)=>t?X(t,e%t):e,$=(e,t)=>e+(t-X(e,t));function I(e,t,r,n){if(!Array.isArray(e))throw new Error("convertRadix2: data should be array");if(t<=0||t>32)throw new Error(`convertRadix2: wrong from=${t}`);if(r<=0||r>32)throw new Error(`convertRadix2: wrong to=${r}`);if($(t,r)>32)throw new Error(`convertRadix2: carry overflow from=${t} to=${r} carryBits=${$(t,r)}`);let o=0,s=0,i=2**r-1,h=[];for(let a of e){if(m(a),a>=2**t)throw new Error(`convertRadix2: invalid data word=${a} from=${t}`);if(o=o<<t|a,s+t>32)throw new Error(`convertRadix2: carry overflow pos=${s} from=${t}`);for(s+=t;s>=r;s-=r)h.push((o>>s-r&i)>>>0);o&=2**s-1}if(o=o<<r-s&i,!n&&s>=t)throw new Error("Excess padding");if(!n&&o)throw new Error(`Non-zero padding: ${o}`);return n&&s>0&&h.push(o>>>0),h}function q(e){return m(e),{encode:t=>{if(!(t instanceof Uint8Array))throw new Error("radix.encode input should be Uint8Array");return G(Array.from(t),2**8,e)},decode:t=>{if(!Array.isArray(t)||t.length&&typeof t[0]!="number")throw new Error("radix.decode input should be array of strings");return Uint8Array.from(G(t,e,2**8))}}}function g(e,t=!1){if(m(e),e<=0||e>32)throw new Error("radix2: bits should be in (0..32]");if($(8,e)>32||$(e,8)>32)throw new Error("radix2: carry overflow");return{encode:r=>{if(!(r instanceof Uint8Array))throw new Error("radix2.encode input should be Uint8Array");return I(Array.from(r),8,e,!t)},decode:r=>{if(!Array.isArray(r)||r.length&&typeof r[0]!="number")throw new Error("radix2.decode input should be array of strings");return Uint8Array.from(I(r,e,8,t))}}}function V(e){if(typeof e!="function")throw new Error("unsafeWrapper fn should be function");return function(...t){try{return e.apply(null,t)}catch{}}}var Z=w(g(4),x("0123456789ABCDEF"),y("")),ee=w(g(5),x("ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"),k(5),y("")),Ue=w(g(5),x("0123456789ABCDEFGHIJKLMNOPQRSTUV"),k(5),y("")),Le=w(g(5),x("0123456789ABCDEFGHJKMNPQRSTVWXYZ"),y(""),z(e=>e.toUpperCase().replace(/O/g,"0").replace(/[IL]/g,"1"))),te=w(g(6),x("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"),k(6),y("")),re=w(g(6),x("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"),k(6),y("")),j=e=>w(q(58),x(e),y("")),R=j("123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"),$e=j("123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ"),ke=j("rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz"),M=[0,2,3,5,6,7,9,10,11],ne={encode(e){let t="";for(let r=0;r<e.length;r+=8){let n=e.subarray(r,r+8);t+=R.encode(n).padStart(M[n.length],"1")}return t},decode(e){let t=[];for(let r=0;r<e.length;r+=11){let n=e.slice(r,r+11),o=M.indexOf(n.length),s=R.decode(n);for(let i=0;i<s.length-o;i++)if(s[i]!==0)throw new Error("base58xmr: wrong padding");t=t.concat(Array.from(s.slice(s.length-o)))}return Uint8Array.from(t)}};var N=w(x("qpzry9x8gf2tvdw0s3jn54khce6mua7l"),y("")),P=[996825010,642813549,513874426,1027748829,705979059];function L(e){let t=e>>25,r=(e&33554431)<<5;for(let n=0;n<P.length;n++)(t>>n&1)===1&&(r^=P[n]);return r}function K(e,t,r=1){let n=e.length,o=1;for(let s=0;s<n;s++){let i=e.charCodeAt(s);if(i<33||i>126)throw new Error(`Invalid prefix (${e})`);o=L(o)^i>>5}o=L(o);for(let s=0;s<n;s++)o=L(o)^e.charCodeAt(s)&31;for(let s of t)o=L(o)^s;for(let s=0;s<6;s++)o=L(o);return o^=r,N.encode(I([o%2**30],30,5,!1))}function J(e){let t=e==="bech32"?1:734539939,r=g(5),n=r.decode,o=r.encode,s=V(n);function i(c,f,u=90){if(typeof c!="string")throw new Error(`bech32.encode prefix should be string, not ${typeof c}`);if(!Array.isArray(f)||f.length&&typeof f[0]!="number")throw new Error(`bech32.encode words should be array of numbers, not ${typeof f}`);let l=c.length+7+f.length;if(u!==!1&&l>u)throw new TypeError(`Length ${l} exceeds limit ${u}`);return c=c.toLowerCase(),`${c}1${N.encode(f)}${K(c,f,t)}`}function h(c,f=90){if(typeof c!="string")throw new Error(`bech32.decode input should be string, not ${typeof c}`);if(c.length<8||f!==!1&&c.length>f)throw new TypeError(`Wrong string length: ${c.length} (${c}). Expected (8..${f})`);let u=c.toLowerCase();if(c!==u&&c!==c.toUpperCase())throw new Error("String must be lowercase or uppercase");c=u;let l=c.lastIndexOf("1");if(l===0||l===-1)throw new Error('Letter "1" must be present between prefix and data only');let U=c.slice(0,l),A=c.slice(l+1);if(A.length<6)throw new Error("Data must be at least 6 characters long");let _=N.decode(A).slice(0,-6),F=K(U,_,t);if(!A.endsWith(F))throw new Error(`Invalid checksum in ${c}: expected "${F}"`);return{prefix:U,words:_}}let a=V(h);function d(c){let{prefix:f,words:u}=h(c,!1);return{prefix:f,words:u,bytes:n(u)}}return{encode:i,decode:h,decodeToBytes:d,decodeUnsafe:a,fromWords:n,fromWordsUnsafe:s,toWords:o}}var oe=J("bech32"),Be=J("bech32m"),se={encode:e=>new TextDecoder().decode(e),decode:e=>new TextEncoder().encode(e)},ie=w(g(4),x("0123456789abcdef"),y(""),z(e=>{if(typeof e!="string"||e.length%2)throw new TypeError(`hex.decode: expected string, got ${typeof e} with length ${e.length}`);return e.toLowerCase()})),ce={utf8:se,hex:ie,base16:Z,base32:ee,base64:te,base64url:re,base58:R,base58xmr:ne},Te=`Invalid encoding type. Available types: ${Object.keys(ce).join(", ")}`;function D(e){if(!Number.isSafeInteger(e)||e<0)throw new Error(`Wrong positive integer: ${e}`)}function fe(e){if(typeof e!="boolean")throw new Error(`Expected boolean, not ${e}`)}function Q(e,...t){if(!(e instanceof Uint8Array))throw new Error("Expected Uint8Array");if(t.length>0&&!t.includes(e.length))throw new Error(`Expected Uint8Array of length ${t}, not of length=${e.length}`)}function he(e){if(typeof e!="function"||typeof e.create!="function")throw new Error("Hash should be wrapped by utils.wrapConstructor");D(e.outputLen),D(e.blockLen)}function ae(e,t=!0){if(e.destroyed)throw new Error("Hash instance has been destroyed");if(t&&e.finished)throw new Error("Hash#digest() has already been called")}function de(e,t){Q(e);let r=t.outputLen;if(e.length<r)throw new Error(`digestInto() expects output buffer of length at least ${r}`)}var ue={number:D,bool:fe,bytes:Q,hash:he,exists:ae,output:de},B=ue;var le=typeof globalThis=="object"&&"crypto"in globalThis?globalThis.crypto:void 0;var Y=e=>e instanceof Uint8Array;var v=e=>new DataView(e.buffer,e.byteOffset,e.byteLength),p=(e,t)=>e<<32-t|e>>>t,pe=new Uint8Array(new Uint32Array([287454020]).buffer)[0]===68;if(!pe)throw new Error("Non little-endian hardware is not supported");var we=Array.from({length:256},(e,t)=>t.toString(16).padStart(2,"0"));function xe(e){if(!Y(e))throw new Error("Uint8Array expected");let t="";for(let r=0;r<e.length;r++)t+=we[e[r]];return t}function ye(e){if(typeof e!="string")throw new Error(`utf8ToBytes expected string, got ${typeof e}`);return new Uint8Array(new TextEncoder().encode(e))}function S(e){if(typeof e=="string"&&(e=ye(e)),!Y(e))throw new Error(`expected Uint8Array, got ${typeof e}`);return e}var T=class{clone(){return this._cloneInto()}};function W(e){let t=n=>e().update(S(n)).digest(),r=e();return t.outputLen=r.outputLen,t.blockLen=r.blockLen,t.create=()=>e(),t}function ge(e,t,r,n){if(typeof e.setBigUint64=="function")return e.setBigUint64(t,r,n);let o=BigInt(32),s=BigInt(4294967295),i=Number(r>>o&s),h=Number(r&s),a=n?4:0,d=n?0:4;e.setUint32(t+a,i,n),e.setUint32(t+d,h,n)}var C=class extends T{constructor(t,r,n,o){super(),this.blockLen=t,this.outputLen=r,this.padOffset=n,this.isLE=o,this.finished=!1,this.length=0,this.pos=0,this.destroyed=!1,this.buffer=new Uint8Array(t),this.view=v(this.buffer)}update(t){B.exists(this);let{view:r,buffer:n,blockLen:o}=this;t=S(t);let s=t.length;for(let i=0;i<s;){let h=Math.min(o-this.pos,s-i);if(h===o){let a=v(t);for(;o<=s-i;i+=o)this.process(a,i);continue}n.set(t.subarray(i,i+h),this.pos),this.pos+=h,i+=h,this.pos===o&&(this.process(r,0),this.pos=0)}return this.length+=t.length,this.roundClean(),this}digestInto(t){B.exists(this),B.output(t,this),this.finished=!0;let{buffer:r,view:n,blockLen:o,isLE:s}=this,{pos:i}=this;r[i++]=128,this.buffer.subarray(i).fill(0),this.padOffset>o-i&&(this.process(n,0),i=0);for(let f=i;f<o;f++)r[f]=0;ge(n,o-8,BigInt(this.length*8),s),this.process(n,0);let h=v(t),a=this.outputLen;if(a%4)throw new Error("_sha2: outputLen should be aligned to 32bit");let d=a/4,c=this.get();if(d>c.length)throw new Error("_sha2: outputLen bigger than state");for(let f=0;f<d;f++)h.setUint32(4*f,c[f],s)}digest(){let{buffer:t,outputLen:r}=this;this.digestInto(t);let n=t.slice(0,r);return this.destroy(),n}_cloneInto(t){t||(t=new this.constructor),t.set(...this.get());let{blockLen:r,buffer:n,length:o,finished:s,destroyed:i,pos:h}=this;return t.length=o,t.pos=h,t.finished=s,t.destroyed=i,o%r&&t.buffer.set(n),t}};var be=(e,t,r)=>e&t^~e&r,Ee=(e,t,r)=>e&t^e&r^t&r,Ae=new Uint32Array([1116352408,1899447441,3049323471,3921009573,961987163,1508970993,2453635748,2870763221,3624381080,310598401,607225278,1426881987,1925078388,2162078206,2614888103,3248222580,3835390401,4022224774,264347078,604807628,770255983,1249150122,1555081692,1996064986,2554220882,2821834349,2952996808,3210313671,3336571891,3584528711,113926993,338241895,666307205,773529912,1294757372,1396182291,1695183700,1986661051,2177026350,2456956037,2730485921,2820302411,3259730800,3345764771,3516065817,3600352804,4094571909,275423344,430227734,506948616,659060556,883997877,958139571,1322822218,1537002063,1747873779,1955562222,2024104815,2227730452,2361852424,2428436474,2756734187,3204031479,3329325298]),b=new Uint32Array([1779033703,3144134277,1013904242,2773480762,1359893119,2600822924,528734635,1541459225]),E=new Uint32Array(64),O=class extends C{constructor(){super(64,32,8,!1),this.A=b[0]|0,this.B=b[1]|0,this.C=b[2]|0,this.D=b[3]|0,this.E=b[4]|0,this.F=b[5]|0,this.G=b[6]|0,this.H=b[7]|0}get(){let{A:t,B:r,C:n,D:o,E:s,F:i,G:h,H:a}=this;return[t,r,n,o,s,i,h,a]}set(t,r,n,o,s,i,h,a){this.A=t|0,this.B=r|0,this.C=n|0,this.D=o|0,this.E=s|0,this.F=i|0,this.G=h|0,this.H=a|0}process(t,r){for(let f=0;f<16;f++,r+=4)E[f]=t.getUint32(r,!1);for(let f=16;f<64;f++){let u=E[f-15],l=E[f-2],U=p(u,7)^p(u,18)^u>>>3,A=p(l,17)^p(l,19)^l>>>10;E[f]=A+E[f-7]+U+E[f-16]|0}let{A:n,B:o,C:s,D:i,E:h,F:a,G:d,H:c}=this;for(let f=0;f<64;f++){let u=p(h,6)^p(h,11)^p(h,25),l=c+u+be(h,a,d)+Ae[f]+E[f]|0,A=(p(n,2)^p(n,13)^p(n,22))+Ee(n,o,s)|0;c=d,d=a,a=h,h=i+l|0,i=s,s=o,o=n,n=l+A|0}n=n+this.A|0,o=o+this.B|0,s=s+this.C|0,i=i+this.D|0,h=h+this.E|0,a=a+this.F|0,d=d+this.G|0,c=c+this.H|0,this.set(n,o,s,i,h,a,d,c)}roundClean(){E.fill(0)}destroy(){this.set(0,0,0,0,0,0,0,0),this.buffer.fill(0)}},H=class extends O{constructor(){super(),this.A=-1056596264,this.B=914150663,this.C=812702999,this.D=-150054599,this.E=-4191439,this.F=1750603025,this.G=1694076839,this.H=-1090891868,this.outputLen=28}},me=W(()=>new O),He=W(()=>new H);export{oe as bech32,xe as bytesToHex,me as sha256}; +/*! Bundled license information: + +@scure/base/lib/esm/index.js: + (*! scure-base - MIT License (c) 2022 Paul Miller (paulmillr.com) *) + +@noble/hashes/esm/utils.js: + (*! noble-hashes - MIT License (c) 2022 Paul Miller (paulmillr.com) *) +*/ diff --git a/vendor/crypto-helpers.entry.js b/vendor/crypto-helpers.entry.js new file mode 100644 index 00000000..96b36172 --- /dev/null +++ b/vendor/crypto-helpers.entry.js @@ -0,0 +1,3 @@ +export { bech32 } from "@scure/base"; +export { sha256 } from "@noble/hashes/sha256"; +export { bytesToHex } from "@noble/hashes/utils"; diff --git a/views/subscriptions.html b/views/subscriptions.html index 5722aa4a..589dc40e 100644 --- a/views/subscriptions.html +++ b/views/subscriptions.html @@ -1,6 +1,6 @@ <!-- views/subscriptions.html --> <section data-ds="new"> - <h2 class="mb-4 text-xl">Subscriptions</h2> + <h2 class="mb-4 text-xl font-semibold text-text">Subscriptions</h2> <div id="subscriptionsVideoList" class="bv-grid-video"> <div class="sidebar-loading-wrapper" role="status" aria-live="polite"> <div class="sidebar-loading-indicator">