Adds support for NIP-28

.github/workflows/docs.yml

@@ -2,8 +2,7 @@ name: Docs
 
 on:
   push:
-    branches:
-    - main
+    branches: [ "main" ]
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

.github/workflows/swiftlint.yml

@@ -2,9 +2,9 @@ name: SwiftLint
 
 on:
   push:
-    branches: [ '**' ]
-  pull_request_target:
-    branches: [ '**' ]
+    branches: [ "main" ]
+  pull_request:
+    types: [opened, synchronize, reopened]
   workflow_dispatch:
 
 jobs:

.github/workflows/unit.yml

@@ -2,17 +2,17 @@ name: Unit Tests
 
 on:
   push:
-    branches: [ '**' ]
-  pull_request_target:
-    branches: [ '**' ]
+    branches: [ "main" ]
+  pull_request:
+    types: [opened, synchronize, reopened]
   workflow_dispatch:
 
 jobs:
   build-and-test:
     runs-on: macos-latest
     strategy:
       matrix:
-        swift: ['5.8', '5.9', '5.10']
+        swift: ['5.8', '5.9', '5.10', '6.0']
 
     steps:
     - name: Checkout

Sources/NostrSDK/EventKind.swift

@@ -69,6 +69,26 @@ public enum EventKind: RawRepresentable, CaseIterable, Codable, Equatable, Hasha
     /// See [NIP-18](https://github.com/nostr-protocol/nips/blob/master/18.md#nip-18).
     case genericRepost
 
+    /// Create a public chat channel.
+    /// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-40-create-channel).
+    case channelCreation
+
+    /// Update a channel's public metadata.
+    /// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-41-set-channel-metadata).
+    case channelMetadata
+
+    /// Send a text message to a channel.
+    /// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-42-create-channel-message).
+    case channelMessage
+
+    /// User no longer wants to see a certain message.
+    /// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-43-hide-message).
+    case channelHideMessage
+
+    /// User no longer wants to see messages from another user.
+    /// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-44-mute-user).
+    case channelMuteUser
+
     /// This kind of event wraps a `seal` event.
     /// The wrapped seal is always encrypted to a receiver's pubkey using a random, one-time-use private key.
     /// The gift wrap event tags should include any information needed to route the event to its intended recipient,
@@ -140,6 +160,11 @@ public enum EventKind: RawRepresentable, CaseIterable, Codable, Equatable, Hasha
         .reaction,
         .seal,
         .genericRepost,
+        .channelCreation,
+        .channelMetadata,
+        .channelMessage,
+        .channelHideMessage,
+        .channelMuteUser,
         .giftWrap,
         .report,
         .muteList,
@@ -173,6 +198,11 @@ public enum EventKind: RawRepresentable, CaseIterable, Codable, Equatable, Hasha
         case .reaction:                     return 7
         case .seal:                         return 13
         case .genericRepost:                return 16
+        case .channelCreation:              return 40
+        case .channelMetadata:              return 41
+        case .channelMessage:               return 42
+        case .channelHideMessage:           return 43
+        case .channelMuteUser:              return 44
         case .giftWrap:                     return 1059
         case .report:                       return 1984
         case .muteList:                     return 10000
@@ -200,6 +230,11 @@ public enum EventKind: RawRepresentable, CaseIterable, Codable, Equatable, Hasha
         case .reaction:                     return ReactionEvent.self
         case .seal:                         return SealEvent.self
         case .genericRepost:                return GenericRepostEvent.self
+        case .channelCreation:              return CreateChannelEvent.self
+        case .channelMetadata:              return SetChannelMetadataEvent.self
+        case .channelMessage:               return CreateChannelMessageEvent.self
+        case .channelHideMessage:           return HideChannelMessageEvent.self
+        case .channelMuteUser:              return MuteChannelUserEvent.self
         case .giftWrap:                     return GiftWrapEvent.self
         case .report:                       return ReportEvent.self
         case .muteList:                     return MuteListEvent.self

Sources/NostrSDK/EventSerializer.swift

@@ -31,14 +31,14 @@ public enum EventSerializer {
 
         let tagsString: String
         if let tagsData = try? encoder.encode(tags) {
-            tagsString = String(decoding: tagsData, as: UTF8.self)
+            tagsString = String(data: tagsData, encoding: .utf8) ?? "[]"
         } else {
             tagsString = "[]"
         }
 
         let contentString: String
         if let contentData = try? encoder.encode(content) {
-            contentString = String(decoding: contentData, as: UTF8.self)
+            contentString = String(data: contentData, encoding: .utf8) ?? "\"\""
         } else {
             contentString = "\"\""
         }

Sources/NostrSDK/Events/BookmarksListEvent.swift

@@ -149,8 +149,8 @@ public extension EventCreating {
         var encryptedContent: String?
         if !privateTags.isEmpty {
             let rawPrivateTags = privateTags.map { $0.raw }
-            if let unencryptedData = try? JSONSerialization.data(withJSONObject: rawPrivateTags) {
-                let unencryptedContent = String(decoding: unencryptedData, as: UTF8.self)
+            if let unencryptedData = try? JSONSerialization.data(withJSONObject: rawPrivateTags),
+               let unencryptedContent = String(data: unencryptedData, encoding: .utf8) {
                 encryptedContent = try legacyEncrypt(content: unencryptedContent,
                                                      privateKey: keypair.privateKey,
                                                      publicKey: keypair.publicKey)

Sources/NostrSDK/Events/Channels/ChannelMetadata.swift

@@ -0,0 +1,45 @@
+//
+//  ChannelMetadata.swift
+//
+//
+//  Created by Konstantin Yurchenko, Jr on 9/20/24.
+//
+
+import Foundation
+
+/// A structure that describes channel.
+///
+/// See [NIP-28 Specification](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-40-create-channel).
+public struct ChannelMetadata: Codable {
+    /// Channel name
+    public let name: String?
+    /// Channel desctription
+    public let about: String?
+    /// URL of channel picture
+    public let picture: String?
+    /// List of relays to download and broadcast events to
+    public let relays: [String]?
+
+    enum CodingKeys: String, CodingKey {
+        case name
+        case about
+        case picture
+        case relays
+    }
+
+    public init(name: String? = nil, about: String? = nil, picture: String? = nil, relays: [String] = []) {
+        self.name = name
+        self.about = about
+        self.picture = picture
+        self.relays = relays
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        name = try container.decodeIfPresent(String.self, forKey: .name)
+        about = try container.decodeIfPresent(String.self, forKey: .about)
+        picture = try container.decodeIfPresent(String.self, forKey: .picture)
+        relays = try container.decodeIfPresent([String].self, forKey: .relays)
+    }
+}

Sources/NostrSDK/Events/Channels/CreateChannelEvent.swift

@@ -0,0 +1,76 @@
+//
+//  CreateChannelEvent.swift
+//
+//
+//  Created by Konstantin Yurchenko, Jr on 9/11/24.
+//
+
+import Foundation
+
+/// Create a public chat channel.
+/// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-40-create-channel).
+public class CreateChannelEvent: NostrEvent {
+
+    public required init(from decoder: Decoder) throws {
+        try super.init(from: decoder)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    required init(kind: EventKind, content: String, tags: [Tag] = [], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), signedBy keypair: Keypair) throws {
+        try super.init(kind: kind, content: content, tags: tags, createdAt: createdAt, signedBy: keypair)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    required init(kind: EventKind, content: String, tags: [Tag] = [], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), pubkey: String) {
+        super.init(kind: kind, content: content, tags: tags, createdAt: createdAt, pubkey: pubkey)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    override init(id: String, pubkey: String, createdAt: Int64, kind: EventKind, tags: [Tag], content: String, signature: String?) {
+        super.init(id: id, pubkey: pubkey, createdAt: createdAt, kind: kind, tags: tags, content: content, signature: signature)
+    }
+
+    init(content: String, tags: [Tag], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), signedBy keypair: Keypair) throws {
+        try super.init(kind: Self.kind, content: content, tags: tags, createdAt: createdAt, signedBy: keypair)
+    }
+
+    class var kind: EventKind {
+        .channelCreation
+    }
+}
+
+public extension EventCreating {
+    func createChannelEvent(withContent content: String, signedBy keypair: Keypair) throws -> CreateChannelEvent {
+        return try CreateChannelEvent(content: content, tags: [], signedBy: keypair)
+    }
+}
+
+public extension CreateChannelEvent {
+    /// Builder of ``CreateChannelEvent``.
+    final class Builder: NostrEvent.Builder<CreateChannelEvent> {
+        public init() {
+            super.init(kind: .channelCreation)
+        }
+
+        public final func channelMetadata(_ channelMetadata: ChannelMetadata, merging rawChannelMetadata: [String: Any] = [:]) throws -> Self {
+            let channelMetadataAsData = try JSONEncoder().encode(channelMetadata)
+
+            let allChannelMetadataAsData: Data
+            if rawChannelMetadata.isEmpty {
+                allChannelMetadataAsData = channelMetadataAsData
+            } else {
+                var channelMetadataAsDictionary = try JSONSerialization.jsonObject(with: channelMetadataAsData, options: []) as? [String: Any] ?? [:]
+                channelMetadataAsDictionary.merge(rawChannelMetadata) { (current, _) in current }
+                allChannelMetadataAsData = try JSONSerialization.data(withJSONObject: channelMetadataAsDictionary, options: .sortedKeys)
+            }
+
+            guard let allChannelMetadataAsString = String(data: allChannelMetadataAsData, encoding: .utf8) else {
+                throw EventCreatingError.invalidInput
+            }
+
+            content(allChannelMetadataAsString)
+
+            return self
+        }
+    }
+}

Sources/NostrSDK/Events/Channels/CreateChannelMessageEvent.swift

@@ -0,0 +1,62 @@
+//
+//  CreateChannelMessageEvent.swift
+//
+//
+//  Created by Konstantin Yurchenko, Jr on 9/11/24.
+//
+
+import Foundation
+
+/// Send a text message to a channel.
+/// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-42-create-channel-message).
+public class CreateChannelMessageEvent: NostrEvent {
+
+    public required init(from decoder: Decoder) throws {
+        try super.init(from: decoder)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    required init(kind: EventKind, content: String, tags: [Tag] = [], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), signedBy keypair: Keypair) throws {
+        try super.init(kind: kind, content: content, tags: tags, createdAt: createdAt, signedBy: keypair)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    required init(kind: EventKind, content: String, tags: [Tag] = [], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), pubkey: String) {
+        super.init(kind: kind, content: content, tags: tags, createdAt: createdAt, pubkey: pubkey)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    override init(id: String, pubkey: String, createdAt: Int64, kind: EventKind, tags: [Tag], content: String, signature: String?) {
+        super.init(id: id, pubkey: pubkey, createdAt: createdAt, kind: kind, tags: tags, content: content, signature: signature)
+    }
+
+    init(content: String, tags: [Tag], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), signedBy keypair: Keypair) throws {
+        try super.init(kind: Self.kind, content: content, tags: tags, createdAt: createdAt, signedBy: keypair)
+    }
+
+    class var kind: EventKind {
+        .channelMessage
+    }
+}
+
+public extension EventCreating {
+    func createChannelMessageEvent(
+        withContent content: String,
+        eventId: String,
+        relayUrl: String,
+        hashtag: String? = nil,
+        signedBy keypair: Keypair
+    ) throws -> CreateChannelMessageEvent {
+
+        var tags: [Tag] = [
+            Tag.pubkey(keypair.publicKey.hex),
+            Tag.event(eventId, otherParameters: [relayUrl, "root"]),
+        ]
+
+        if let hashtag = hashtag {
+            tags.append(Tag.hashtag(hashtag))
+        }
+
+        return try CreateChannelMessageEvent(content: content, tags: tags, signedBy: keypair)
+    }
+}

Sources/NostrSDK/Events/Channels/HideChannelMessageEvent.swift

@@ -0,0 +1,46 @@
+//
+//  HideChannelMessageEvent.swift
+//
+//
+//  Created by Konstantin Yurchenko, Jr on 9/11/24.
+//
+
+import Foundation
+
+/// User no longer wants to see a certain message.
+/// See [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md#kind-43-hide-message).
+public class HideChannelMessageEvent: NostrEvent {
+
+    public required init(from decoder: Decoder) throws {
+        try super.init(from: decoder)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    required init(kind: EventKind, content: String, tags: [Tag] = [], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), signedBy keypair: Keypair) throws {
+        try super.init(kind: kind, content: content, tags: tags, createdAt: createdAt, signedBy: keypair)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    required init(kind: EventKind, content: String, tags: [Tag] = [], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), pubkey: String) {
+        super.init(kind: kind, content: content, tags: tags, createdAt: createdAt, pubkey: pubkey)
+    }
+
+    @available(*, unavailable, message: "This initializer is unavailable for this class.")
+    override init(id: String, pubkey: String, createdAt: Int64, kind: EventKind, tags: [Tag], content: String, signature: String?) {
+        super.init(id: id, pubkey: pubkey, createdAt: createdAt, kind: kind, tags: tags, content: content, signature: signature)
+    }
+
+    init(content: String, tags: [Tag], createdAt: Int64 = Int64(Date.now.timeIntervalSince1970), signedBy keypair: Keypair) throws {
+        try super.init(kind: Self.kind, content: content, tags: tags, createdAt: createdAt, signedBy: keypair)
+    }
+
+    class var kind: EventKind {
+        .channelHideMessage
+    }
+}
+
+public extension EventCreating {
+    func hideChannelMessageEvent(withContent content: String, signedBy keypair: Keypair) throws -> HideChannelMessageEvent {
+        return try HideChannelMessageEvent(content: content, tags: [], signedBy: keypair)
+    }
+}