Softchat/com.softcose.softchat.protocol

Package-level declarations

Identity and external signing; NIP-44; Softchat chat/account event writers and classifiers; relay sessions and persistence results; Noise and Negentropy state; attachment metadata and streams; NIP-42/NIP-98 plans; version metadata, redacted diagnostics, and stable public failures.

Types

AppDataContext

enum AppDataContext : Enum<AppDataContext>

Accepted kind-30079 contexts.

AppDataSync

data class AppDataSync(val event: SignedNostrEvent, val context: AppDataContext, val json: String)

Authenticated and self-decrypted kind-30079 application data.

ApplicationData

data class ApplicationData(val event: SignedNostrEvent, val identifier: String, val content: String)

Direct generic NIP-78 application data.

AttachmentCrypto

object AttachmentCrypto

Bounded compatibility crypto for released-client attachment values.

AttachmentDecryptionStream

class AttachmentDecryptionStream(key: ByteArray, nonce: ByteArray) : AutoCloseable

Incremental authenticated decryption for a private staged destination.

AttachmentEncryptionStream

class AttachmentEncryptionStream(key: ByteArray) : AutoCloseable

Incremental encryption compatible with released clients.

AttachmentMetadata

data class AttachmentMetadata(val url: String, val mimeType: String? = null, val sha256: String? = null, val originalSha256: String? = null, val byteSize: ULong? = null, val dimensions: String? = null, val name: String? = null, val magnet: String? = null, val infohash: String? = null, val blurhash: String? = null, val thumbnailUrl: String? = null, val imageUrl: String? = null, val summary: String? = null, val alt: String? = null, val fallbackUrls: List<String> = emptyList(), val service: String? = null, val encryption: String? = null, val unknownFields: List<String> = emptyList())

Canonical Softchat imeta metadata; HTTP and files remain platform-owned.

AttachmentTransformFinal

data class AttachmentTransformFinal(val authenticationTag: ByteArray, val plaintextSha256: String, val encryptedSha256: String, val byteCount: ULong)

Final authentication and hash values for one staged attachment transform.

ChatMessage

data class ChatMessage(val rumor: NostrRumor, val participants: List<NostrPublicKey>, val relation: ChatRelation?, val attachments: List<AttachmentMetadata>, val emojiTags: List<List<String>>, val extensionTags: List<List<String>>)

Typed complete kind-14 message with exact raw rumor retained.

ChatMessageDraft

data class ChatMessageDraft(val createdAt: Long, val participants: List<NostrPublicKey>, val content: String, val relation: ChatRelation = ChatRelation.None, val attachments: List<AttachmentMetadata> = emptyList(), val emojiTags: List<List<String>> = emptyList(), val extensionTags: List<List<String>> = emptyList())

Complete canonical kind-14 writer input.

ChatRelation

sealed interface ChatRelation

Canonical message relation.

Contact

data class Contact(val publicKey: NostrPublicKey, val relayHint: String = "", val localName: String = "")

One private contact-backup entry.

Deletion

data class Deletion(val rumor: NostrRumor, val eventIds: List<NostrEventId>, val reason: String)

Typed authorized deletion request.

Edit

data class Edit(val rumor: NostrRumor, val originalEventId: NostrEventId, val participants: List<NostrPublicKey>, val content: String, val emojiTags: List<List<String>>, val compatibilityTags: List<List<String>>)

Typed text-and-emoji edit.

EncryptedMessage

data class EncryptedMessage

An immutable language-owned encrypted message.

EncryptionAlgorithm

enum EncryptionAlgorithm : Enum<EncryptionAlgorithm>

The encryption profile represented by EncryptedMessage.

ExternalEventSigningRequest

data class ExternalEventSigningRequest

Immutable fields passed to a host signer.

ExternalSignerCapabilities

data class ExternalSignerCapabilities(val signEvents: Boolean, val nip44Encrypt: Boolean, val nip44Decrypt: Boolean)

Independently advertised capabilities of a host or hardware signer.

FollowList

data class FollowList(val rumor: NostrRumor, val contacts: List<Contact>, val containedDuplicates: Boolean)

Parsed private author-copy follow list.

HttpAuthorizationPlan

data class HttpAuthorizationPlan(val method: String, val url: String, val payloadSha256: String?, val authorizationHeader: String, val event: SignedNostrEvent, val allowAuthorizationOnRedirect: Boolean)

Signed NIP-98 plan; create a fresh plan after every redirect.

NegentropyClient

class NegentropyClient(items: List<NegentropyItem>, frameSizeLimit: ULong) : AutoCloseable

Bounded stateful NIP-77 client.

NegentropyItem

data class NegentropyItem(val createdAt: Long, val eventId: NostrEventId)

One item in a local NIP-77 set.

NegentropyStep

data class NegentropyStep(val outgoing: ByteArray?, val haveEventIds: List<NostrEventId>, val needEventIds: List<NostrEventId>, val complete: Boolean)

One stateful NIP-77 client result.

Nip44Payload

@JvmInline

value class Nip44Payload

A bounded, encoded NIP-44 payload with redacted diagnostics.

NoiseClientHandshake

class NoiseClientHandshake(relayStaticPublicKey: ByteArray, requestChunking: Boolean = true) : AutoCloseable

Single-use exact deployed Noise NK handshake.

NoiseTransport

class NoiseTransport : AutoCloseable

Serialized authenticated Noise transport; native code owns the WebSocket.

Reaction

data class Reaction(val rumor: NostrRumor, val eventId: NostrEventId, val eventAuthors: List<NostrPublicKey>, val eventKind: NostrEventKind, val value: String, val customEmojiUrl: String?)

Typed reaction.

RelaySession

class RelaySession : AutoCloseable

Serialized relay protocol state machine; native code owns socket lifecycle.

RelaySessionAction

data class RelaySessionAction(val kind: RelaySessionAction.Kind, val frame: String, val value: String, val event: SignedNostrEvent?, val delayMillis: ULong)

Platform action emitted by the pure relay session.

RelaySessionSnapshot

data class RelaySessionSnapshot(val state: RelaySessionSnapshot.State, val subscriptions: List<String>, val readySubscriptions: List<String>, val deliveryEventIds: List<NostrEventId>, val pendingIngestionIds: List<NostrEventId>, val reconnectAttempt: UInt)

Redacted state snapshot for host diagnostics and restoration policy.

Softchat

object Softchat

Metadata for the loaded Softchat artifact.

SoftchatBuildFingerprint

data class SoftchatBuildFingerprint(val version: String, val revision: String, val protocolProfile: Int, val targetArchitecture: String, val targetOperatingSystem: String)

Stable, redacted build metadata safe for logs and crash reports.

SoftchatDiagnosticsSnapshot

data class SoftchatDiagnosticsSnapshot(val nip44Encryptions: ULong, val nip44Decryptions: ULong, val verifiedEvents: ULong, val signedEvents: ULong, val wrappedEnvelopes: ULong, val unwrappedEnvelopes: ULong, val rejectedOperations: ULong, val inputBytes: ULong, val outputBytes: ULong)

Monotonic process-local counters containing no keys or protocol contents.

SoftchatErrorCode

enum SoftchatErrorCode : Enum<SoftchatErrorCode>

Stable machine-readable Softchat failures.

SoftchatEvents

object SoftchatEvents

Rust-validated typed readers for binding-owned rumors.

SoftchatException

sealed class SoftchatException : Exception

Safe, stable failures from the public Kotlin API.

SoftchatIdentity

class SoftchatIdentity

A local Nostr identity backed by Rust-owned secret material.

Subject

data class Subject(val rumor: NostrRumor, val participants: List<NostrPublicKey>, val text: String, val iconUrl: String?, val iconDimensions: String?, val emojiTags: List<List<String>>, val extensionTags: List<List<String>>)

Typed group-subject update.

SubjectDraft

data class SubjectDraft(val createdAt: Long, val participants: List<NostrPublicKey>, val subject: String, val emojiTags: List<List<String>> = emptyList(), val icon: AttachmentMetadata? = null, val extensionTags: List<List<String>> = emptyList())

Canonical group-subject writer input.

Typing

data class Typing(val rumor: NostrRumor, val participants: List<NostrPublicKey>)

Typed ephemeral typing notification.

UserMetadata

data class UserMetadata(val rumor: NostrRumor, val name: String?, val displayName: String?, val about: String?, val picture: String?, val website: String?, val banner: String?, val bot: Boolean?, val unknownJson: String)

Parsed private metadata.

UserMetadataDraft

data class UserMetadataDraft(val createdAt: Long, val name: String? = null, val displayName: String? = null, val about: String? = null, val picture: String? = null, val website: String? = null, val banner: String? = null, val bot: Boolean? = null, val unknownJson: String = "{}")

Private user-metadata writer fields with retained unknown JSON.