Softchat/com.softcose.softchat.sdk

Package-level declarations

Android account lifecycle and Rust-owned product state; NIP-44; Softchat chat/account values; 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

AccountConnectionState

enum AccountConnectionState : Enum<AccountConnectionState>

Redacted Rust-owned connection state.

AccountContacts

class AccountContacts

Rust-owned Android-local address-book operations.

AccountConversations

class AccountConversations

Complete conversation commands and bounded queries.

AccountDatabaseInfo

data class AccountDatabaseInfo(val accountId: String, val schemaVersion: Long, val revision: Long, val writeAheadLogging: Boolean)

Rust-owned database metadata.

AccountDelivery

class AccountDelivery

Durable delivery operations; Android owns only transport execution.

AccountDescriptor

data class AccountDescriptor(val publicKey: PublicKey, val databaseFilename: String)

Identity-derived non-secret account storage reference.

AccountDiagnostics

data class AccountDiagnostics(val schemaVersion: Long, val revision: Long, val activeRelayUrl: String?, val relayCount: UInt, val unfinishedDeliveryCount: UInt, val recoverableMediaCount: UInt, val storedEventCount: UInt, val quarantineCount: UInt, val databaseBytes: ULong)

Redacted bounded account health suitable for logs and support UI.

AccountEventNode

data class AccountEventNode(val projection: AccountProjection, val effectiveContent: String, val deleted: Boolean, val edited: Boolean, val replyCount: UInt)

One complete use-case node derived in Rust from authenticated truth.

AccountEvents

class AccountEvents

Exact authenticated event detail and relationship queries.

AccountIncoming

class AccountIncoming

Atomic incoming account operations.

AccountMedia

class AccountMedia

Logical media operations and authenticated gallery queries.

AccountMessage

data class AccountMessage(val eventId: String, val conversationId: String, val authorPublicKey: NostrPublicKey, val createdAt: Long, val content: String, val deleted: Boolean, val edited: Boolean, val replyToEventId: String?)

One authenticated message view.

AccountMessages

class AccountMessages

Complete high-level messaging commands and bounded effective-message queries.

AccountMutationResult

data class AccountMutationResult(val revision: Long)

A committed mutation carrying the revision Android should publish to observers.

AccountOperationResult

data class AccountOperationResult(val operation: OperationSnapshot, val revision: Long, val inserted: Boolean)

Result of one idempotent outgoing operation.

AccountOperations

class AccountOperations

Durable outgoing-operation state and observation.

AccountOutgoing

class AccountOutgoing

Atomic outgoing account operations.

AccountProfiles

class AccountProfiles

Effective profile and private follow-list commands.

AccountProjection

data class AccountProjection(val kind: ProjectionKind, val logicalEventId: String, val outerEvent: SignedNostrEvent, val rumor: NostrRumor?, val authorPublicKey: NostrPublicKey, val createdAt: Long, val conversationId: String, val participants: List<NostrPublicKey>, val targetEventIds: List<String>, val content: String)

One bounded authenticated projection with exact protocol truth attached.

AccountPush

class AccountPush

Durable platform-token registration.

AccountQueries

class AccountQueries

Bounded authenticated use-case queries.

AccountRecovery

class AccountRecovery

One-shot recovery from retired platform storage.

AccountRelays

class AccountRelays

Rust-owned durable relay catalog for one account.

AccountResources

class AccountResources

Account-scoped cache operations used by Android HTTP and picker executors.

AccountSettings

data class AccountSettings(val schemaVersion: UInt, val quickReaction: String?, val typingIndicatorsEnabled: Boolean, val notificationContentPrivacy: NotificationContentPrivacy, val mediaService: String?, val imageUploadQuality: UploadQuality, val videoUploadQuality: UploadQuality, val preserveHdr: Boolean, val transcriptionLocale: String?, val domainReplacementRulesJson: String, val chatWallpaper: String?, val customEmojiReferences: List<CustomEmojiReference>, val savedStickerReferences: List<String>, val seasonalAppearance: String?)

Complete versioned account settings after Rust validation and merging.

AccountSettingsPatch

data class AccountSettingsPatch(val quickReaction: SettingPatch<String> = SettingPatch.Unchanged, val typingIndicatorsEnabled: SettingPatch<Boolean> = SettingPatch.Unchanged, val notificationContentPrivacy: SettingPatch<NotificationContentPrivacy> = SettingPatch.Unchanged, val mediaService: SettingPatch<String> = SettingPatch.Unchanged, val imageUploadQuality: SettingPatch<UploadQuality> = SettingPatch.Unchanged, val videoUploadQuality: SettingPatch<UploadQuality> = SettingPatch.Unchanged, val preserveHdr: SettingPatch<Boolean> = SettingPatch.Unchanged, val transcriptionLocale: SettingPatch<String> = SettingPatch.Unchanged, val domainReplacementRulesJson: SettingPatch<String> = SettingPatch.Unchanged, val chatWallpaper: SettingPatch<String> = SettingPatch.Unchanged, val customEmojiReferences: SettingPatch<List<CustomEmojiReference>> = SettingPatch.Unchanged, val savedStickerReferences: SettingPatch<List<String>> = SettingPatch.Unchanged, val seasonalAppearance: SettingPatch<String> = SettingPatch.Unchanged)

Typed versioned patch; unspecified fields are preserved by Rust.

AccountSettingsService

class AccountSettingsService

Versioned account-settings queries and merge patches.

AccountSupport

class AccountSupport

Redacted account health for support and explicit recovery flows.

AccountSynchronization

class AccountSynchronization

Rust-owned synchronization factory; Android executes only returned transport actions.

AccountTransport

class AccountTransport

Low-level host-owned WebSocket boundary over durable delivery and inbox state.

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.

AssetReplacementTarget

enum AssetReplacementTarget : Enum<AssetReplacementTarget>

Profile or conversation field changed after a durable public upload.

AttachmentCrypto

object AttachmentCrypto

Bounded compatibility crypto for released-client attachment values.

AttachmentDecryptionStream

class AttachmentDecryptionStream : AutoCloseable

Incremental authenticated decryption for a private staged destination.

AttachmentEncryptionStream

class AttachmentEncryptionStream : 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.

ClaimedDelivery

class ClaimedDelivery

One committed exclusive lease.

CommandId

@JvmInline

value class CommandId(val value: String)

Stable idempotency key for one user action.

Contact

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

One private contact-backup entry.

Conversation

data class Conversation(val id: ConversationId, val members: List<PublicKey>, val subject: String, val subjectIcon: AttachmentMetadata?, val lastMessage: Message?, val messageCount: UInt, val unreadCount: UInt, val archived: Boolean, val pinned: Boolean, val readCursor: MessageCursor?, val forcedUnread: Boolean, val draft: ConversationDraft?, val lastActivityAt: Long)

Complete bounded conversation row consumed directly by Android UI.

ConversationCursor

data class ConversationCursor(val pinned: Boolean, val lastActivityAt: Long, val conversationId: ConversationId)

Lossless conversation-list paging position.

ConversationDraft

data class ConversationDraft(val text: String, val emojiTags: List<List<String>> = emptyList(), val spans: List<DraftSpan> = emptyList(), val replyTo: MessageId? = null, val attachmentOperationIds: List<String> = emptyList(), val updatedAt: Long = 0)

Portable draft state shared by Android and future Apple clients.

ConversationId

@JvmInline

value class ConversationId

Stable participant-set identifier for one conversation.

ConversationPage

data class ConversationPage(val conversations: List<Conversation>, val nextCursor: ConversationCursor?)

One bounded complete conversation page.

ConversationReadState

data class ConversationReadState(val conversationId: ConversationId, val boundary: MessageCursor?, val forcedUnread: Boolean, val updatedAt: Long, val updateId: String)

Effective versioned cross-device read state for one conversation.

ConversationSummary

data class ConversationSummary(val conversationId: String, val participants: List<NostrPublicKey>, val lastMessage: String, val lastCreatedAt: Long, val messageCount: UInt)

Newest-first conversation summary from authenticated durable projections.

ConversationView

data class ConversationView(val summary: ConversationSummary, val lastMessage: AccountEventNode, val subject: AccountProjection?)

Complete conversation-list use case produced by Rust in one native call.

CustomEmojiReference

data class CustomEmojiReference(val shortcode: String, val url: String)

One validated portable custom emoji saved by the account.

Deletion

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

Typed authorized deletion request.

DeliveryClaim

class DeliveryClaim

One bounded exclusive delivery lease.

DeliveryDecision

data class DeliveryDecision(val eventId: NostrEventId, val state: DeliveryState, val category: String, val relayMessage: String)

Stable result of one relay acknowledgement.

DeliveryIntentSnapshot

data class DeliveryIntentSnapshot(val intentId: String, val operationId: String, val eventCopyId: String, val relayUrl: String, val payloadBytes: ULong, val state: DeliveryIntentState, val leaseId: String = "", val attemptCount: UInt)

Exact persisted delivery row consumed by Rust reducers.

DeliveryIntentState

enum DeliveryIntentState : Enum<DeliveryIntentState>

Durable state of one event-copy/relay intent.

DeliveryPayload

data class DeliveryPayload(val intentId: String, val relayUrl: String, val eventJson: String)

Exact event payload Android may write after a claim commits.

DeliveryState

enum DeliveryState : Enum<DeliveryState>

Durable host-owned delivery state for one authored event.

DeliveryStateMutation

data class DeliveryStateMutation(val intentId: String, val state: DeliveryIntentState, val leaseId: String, val category: String, val attemptCount: UInt)

Atomic delivery-row mutation returned by Rust.

DnsRelayRecord

data class DnsRelayRecord(val target: String, val priority: UInt, val weight: UInt, val ttlSeconds: UInt)

One authenticated DNS relay record supplied by Android.

DraftSpan

data class DraftSpan(val startUtf16: UInt, val endUtf16: UInt, val kind: DraftSpanKind, val value: String = "")

One validated half-open UTF-16 range in a portable draft.

DraftSpanKind

enum DraftSpanKind : Enum<DraftSpanKind>

Portable draft state shared by Android and future Apple clients.

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.

data class Follow(val publicKey: PublicKey, val relayHint: String? = null, val localName: String? = null)

One private follow-list entry with optional relay hint and local name.

FollowList

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

Parsed private author-copy follow list.

GenericRepost

data class GenericRepost(val repost: SignedNostrEvent, val embeddedEvent: SignedNostrEvent)

Validated receive-only NIP-18 generic repost.

HttpAuthorizationPlan

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

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

IncomingChange

data class IncomingChange(val kind: IncomingChangeKind, val logicalId: String, val targetMessageIds: List<MessageId>, val conversationId: ConversationId?, val author: PublicKey, val createdAt: Long)

Authenticated product change suitable for Android notifications and refresh decisions.

IncomingChangeKind

enum IncomingChangeKind : Enum<IncomingChangeKind>

Product-level change families emitted by authenticated incoming ingestion.

IncomingResult

data class IncomingResult(val insertedEventIds: List<String>, val duplicateEventIds: List<String>, val quarantinedEventIds: List<String>, val revision: Long, val affectedMessages: List<Message>, val affectedConversationIds: List<ConversationId>, val changes: List<IncomingChange>)

Durable result of one Android push or notification event batch.

IncomingRoute

data class IncomingRoute(val eventId: NostrEventId, val recipient: PublicKey, val envelopeKind: Nip59EnvelopeKind)

Verified account-routing hint from one signed NIP-59 outer wrapper.

IngestionBatch

data class IngestionBatch(val accountId: String, val events: List<SignedNostrEvent>)

One bounded atomic-ingestion request for the portable session contract.

IngestionReceipt

data class IngestionReceipt(val accountId: String, val insertedEventIds: List<String>, val duplicateEventIds: List<String>, val quarantinedEventIds: List<String>)

Total result of one atomic ingestion transaction.

IngestionResult

data class IngestionResult(val insertedEventIds: List<NostrEventId>, val duplicateEventIds: List<NostrEventId>, val quarantinedEventIds: List<NostrEventId>)

Total classification returned after one authoritative database transaction.

LinkPreviewRecord

data class LinkPreviewRecord(val url: String, val title: String?, val description: String?, val imageUrl: String?, val updatedAtMillis: Long)

One bounded account-scoped HTTP link-preview cache result.

LocalContact

data class LocalContact(val publicKey: PublicKey, val name: String?, val updatedAtMillis: Long)

One Android-local address-book entry.

ManagedAccountTransport

class ManagedAccountTransport : AutoCloseable

Lifecycle owner for the SDK-managed native relay transport.

ManagedTransportFailure

enum ManagedTransportFailure : Enum<ManagedTransportFailure>

Stable, redacted failure of the optional SDK-owned relay transport.

ManagedTransportState

data class ManagedTransportState(val sequence: ULong, val revision: Long, val connectionState: AccountConnectionState, val idle: Boolean, val typingIndicators: List<TypingIndicator>, val synchronization: SynchronizationState?, val lastFailure: ManagedTransportFailure?, val networkAvailable: Boolean, val stopped: Boolean)

Complete observable state of the optional SDK-owned relay transport.

MediaCompletion

data class MediaCompletion(val operation: MediaOperation, val completedOperation: OperationResult?)

Result of acknowledging one completed attachment lease.

MediaDirection

enum MediaDirection : Enum<MediaDirection>

Direction of a logical platform-executed media transfer.

MediaItem

data class MediaItem(val messageId: MessageId, val conversationId: ConversationId, val author: PublicKey, val createdAt: Long, val attachment: AttachmentMetadata)

One authenticated attachment projected into a bounded media gallery.

MediaLease

data class MediaLease(val leaseId: String, val expiresAt: Long, val operation: MediaOperation)

Exclusive bounded claim for one platform media executor.

MediaOperation

data class MediaOperation(val id: String, val commandId: CommandId, val conversationId: ConversationId?, val sourceMessageId: MessageId?, val direction: MediaDirection, val protection: MediaProtection, val state: MediaOperationState, val sourceFingerprint: String, val attachment: AttachmentMetadata?, val byteCount: ULong?, val attemptCount: UInt, val lastErrorCategory: String?, val updatedAt: Long)

One durable logical transfer without Android URI or WorkManager identifiers.

MediaOperationPage

data class MediaOperationPage(val operations: List<MediaOperation>, val nextCursor: String?)

One stable page of operations that an Android executor can resume.

MediaOperationState

enum MediaOperationState : Enum<MediaOperationState>

Durable state of a logical media operation.

MediaPreparation

data class MediaPreparation(val sourceFingerprint: String)

One private staged source selected for an attachment-dependent message.

MediaProtection

enum MediaProtection : Enum<MediaProtection>

Whether an upload is private encrypted content or an intentionally public asset.

Message

data class Message(val id: MessageId, val conversationId: ConversationId, val author: PublicKey, val createdAt: Long, val content: MessageContent, val relation: MessageRelation, val relatedMessageId: MessageId?, val forwardedAuthor: PublicKey?, val edited: Boolean, val deleted: Boolean, val replyCount: UInt, val reactions: List<MessageReaction>)

Complete effective message consumed directly by Android UI.

MessageContent

data class MessageContent(val text: String = "", val attachments: List<AttachmentMetadata> = emptyList(), val emojiTags: List<List<String>> = emptyList())

User-authored content for a new or edited message.

MessageCursor

data class MessageCursor(val createdAt: Long, val messageId: MessageId)

Lossless newest-first message paging position.

MessageId

@JvmInline

value class MessageId

Stable authenticated logical event identifier for one message.

MessageLocalExtras

data class MessageLocalExtras(val messageId: MessageId, val transcript: String?, val waveform: ByteArray, val updatedAt: Long)

Sparse account-local non-protocol data attached to one message.

MessagePage

data class MessagePage(val messages: List<Message>, val nextCursor: MessageCursor?)

One bounded complete message page.

MessageReaction

data class MessageReaction(val id: String, val author: PublicKey, val value: String, val customEmojiUrl: String?, val createdAt: Long)

One effective non-deleted reaction.

MessageRelation

enum MessageRelation : Enum<MessageRelation>

Effective relationship of one authenticated message.

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.

Nip44EncryptedMessage

data class Nip44EncryptedMessage

An immutable language-owned encrypted message.

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 framing state for low-level transport callers.

NotificationContentPrivacy

enum NotificationContentPrivacy : Enum<NotificationContentPrivacy>

Notification text privacy shared across devices.

OperationResult

data class OperationResult(val operation: OperationSnapshot, val revision: Long, val inserted: Boolean, val message: Message?)

Durable result of one idempotent high-level product command.

OperationSnapshot

data class OperationSnapshot(val operationId: String, val state: OperationState, val totalIntents: UInt, val acceptedIntents: UInt, val rejectedIntents: UInt, val queuedIntents: UInt, val activeIntents: UInt)

Aggregate operation state for UI.

OperationState

enum OperationState : Enum<OperationState>

User-visible aggregate state derived from durable delivery rows.

OutboundRelayFrame

data class OutboundRelayFrame(val frame: String, val deliveryEventIds: List<NostrEventId>)

One frame removed from the relay session's bounded queue.

PendingAssetReplacement

data class PendingAssetReplacement(val commandId: CommandId, val target: AssetReplacementTarget, val conversationId: ConversationId?, val state: PendingAssetReplacementState, val operation: MediaOperation, val resultOperationId: String?, val updatedAt: Long)

Durable public asset replacement with one platform upload dependency.

PendingAssetReplacementState

enum PendingAssetReplacementState : Enum<PendingAssetReplacementState>

Aggregate lifecycle of an upload-dependent public asset replacement.

PendingMediaMessage

data class PendingMediaMessage(val commandId: CommandId, val conversationId: ConversationId, val content: MessageContent, val replyTo: MessageId?, val state: PendingMediaMessageState, val attachments: List<MediaOperation>, val resultMessageId: MessageId?, val updatedAt: Long)

Durable message intent with ordered platform transfer dependencies.

PendingMediaMessageState

enum PendingMediaMessageState : Enum<PendingMediaMessageState>

Logical dependency state for an attachment-dependent message.

Profile

data class Profile(val publicKey: PublicKey, val name: String?, val displayName: String?, val about: String?, val picture: String?, val website: String?, val banner: String?, val bot: Boolean?, val unknownJson: String, val localOverride: Boolean, val updatedAt: Long, val firstSeenAt: Long? = null)

Effective authenticated profile with an optional local display-name override.

ProfilePatch

data class ProfilePatch(val name: SettingPatch<String> = SettingPatch.Unchanged, val displayName: SettingPatch<String> = SettingPatch.Unchanged, val about: SettingPatch<String> = SettingPatch.Unchanged, val picture: SettingPatch<String> = SettingPatch.Unchanged, val website: SettingPatch<String> = SettingPatch.Unchanged, val banner: SettingPatch<String> = SettingPatch.Unchanged, val bot: SettingPatch<Boolean> = SettingPatch.Unchanged)

Typed profile merge patch; unspecified fields are preserved by Rust.

ProjectionKind

enum ProjectionKind : Enum<ProjectionKind>

Authenticated projection families exposed to Android use-case queries.

PublicKey

@JvmInline

value class PublicKey

Canonical lowercase 32-byte public key used by the product account API.

PushPlatform

enum PushPlatform : Enum<PushPlatform>

Released push-registration profile selected by the platform executor.

Reaction

data class Reaction(val value: String, val customEmojiUrl: String? = null)

User-selected Unicode or custom-emoji reaction.

RelayCatalogEntry

data class RelayCatalogEntry(val url: String, val createdAt: Long, val isActive: Boolean, val source: RelayCatalogSource, val isDnsDiscovered: Boolean, val isUserExcluded: Boolean, val dnsPriority: Int, val dnsWeight: Int, val dnsExpiresAt: Long)

One persisted relay catalog row.

RelayCatalogMutation

data class RelayCatalogMutation(val entries: List<RelayCatalogEntry>, val revision: Long)

One committed complete relay catalog.

RelayCatalogPlan

data class RelayCatalogPlan(val entries: List<RelayCatalogEntry>, val activeRelayUrl: String, val nextRefreshAt: Long, val usedFallback: Boolean)

Deterministic full relay-catalog replacement.

RelayCatalogPlans

object RelayCatalogPlans

Pure Rust relay catalog, failover, and retry policy.

RelayCatalogSource

enum RelayCatalogSource : Enum<RelayCatalogSource>

Consumer-visible ownership of one relay catalog row.

RelayDeliveryResult

data class RelayDeliveryResult(val intentId: String, val kind: RelayDeliveryResultKind, val category: String)

One redacted terminal or retryable relay result.

RelayDeliveryResultKind

enum RelayDeliveryResultKind : Enum<RelayDeliveryResultKind>

Stable relay response class.

RelayEndpoint

data class RelayEndpoint(val configuredUrl: String, val networkUrl: String, val noiseRemoteStaticKey: ByteArray)

Validated boundary between configured relay identity and its network endpoint.

RelayFailureKind

enum RelayFailureKind : Enum<RelayFailureKind>

Stable transport failure class consumed by the Rust retry policy.

RelayRetryAction

enum RelayRetryAction : Enum<RelayRetryAction>

Retry/failover action selected by Rust.

RelayRetryPlan

data class RelayRetryPlan(val action: RelayRetryAction, val delayMs: ULong, val jitterMaxMs: ULong)

Bounded reconnect or failover plan.

RelaySession

class RelaySession : AutoCloseable

Serialized relay protocol state machine for a host-owned socket lifecycle.

RelaySessionAction

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

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 deliveryStates: List<DeliveryState>, val pendingIngestionIds: List<NostrEventId>, val reconnectAttempt: UInt)

Redacted state snapshot for diagnostics only.

SettingPatch

sealed interface SettingPatch<out T>

Three-state value used by typed settings patches.

Softchat

object Softchat

Stable metadata and redacted diagnostics for the loaded artifact.

SoftchatAccount

class SoftchatAccount : AutoCloseable

The Android account entry point.

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

class SoftchatException : Exception

Safe, stable failures from the public Kotlin API.

SoftchatIdentity

class SoftchatIdentity

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

SoftchatLogBatch

data class SoftchatLogBatch(val events: List<SoftchatLogEvent>, val droppedCount: ULong)

One bounded delivery to SoftchatLogSink.

SoftchatLogCategory

enum SoftchatLogCategory : Enum<SoftchatLogCategory>

Stable subsystem category for one structured SDK diagnostic.

SoftchatLogCounter

data class SoftchatLogCounter(val kind: SoftchatLogCounterKind, val value: ULong)

One SDK-named aggregate measurement.

SoftchatLogCounterKind

enum SoftchatLogCounterKind : Enum<SoftchatLogCounterKind>

Finite, redacted diagnostic classification.

SoftchatLogDirection

enum SoftchatLogDirection : Enum<SoftchatLogDirection>

Finite, redacted diagnostic classification.

SoftchatLogEvent

data class SoftchatLogEvent(val sequence: ULong, val occurrenceCount: ULong, val level: SoftchatLogLevel, val category: SoftchatLogCategory, val operation: String, val errorCode: SoftchatErrorCode?, val durationMicros: ULong?, val revision: Long?, val itemCount: ULong?, val byteCount: ULong?, val summary: String = "Account operation completed", val direction: SoftchatLogDirection? = null, val subject: SoftchatLogSubject? = null, val source: SoftchatLogSource? = null, val relation: SoftchatLogRelation? = null, val frameClass: String? = null, val reasonCode: String? = null, val occurredAtMillis: ULong, val lastOccurredAtMillis: ULong = occurredAtMillis, val counters: List<SoftchatLogCounter> = emptyList())

One immutable, structured, redacted SDK diagnostic.

SoftchatLogging

data class SoftchatLogging(val sink: SoftchatLogSink, val minimumLevel: SoftchatLogLevel = SoftchatLogLevel.INFO)

Optional account logging configuration.

SoftchatLogLevel

enum SoftchatLogLevel : Enum<SoftchatLogLevel>

Severity threshold and severity value for structured SDK diagnostics.

SoftchatLogRelation

enum SoftchatLogRelation : Enum<SoftchatLogRelation>

Finite, redacted diagnostic classification.

SoftchatLogSink

fun interface SoftchatLogSink

Optional application-owned receiver for batched SDK diagnostics.

SoftchatLogSource

enum SoftchatLogSource : Enum<SoftchatLogSource>

Finite, redacted diagnostic classification.

SoftchatLogSubject

enum SoftchatLogSubject : Enum<SoftchatLogSubject>

Finite, redacted diagnostic classification.

StickerRecord

data class StickerRecord(val name: String, val url: String, val associatedEmojis: List<String>)

One validated cached custom emoji or sticker.

StoredEventJson

data class StoredEventJson(val eventId: String, val eventJson: String)

Exact canonical signed event selected from Rust-owned protocol truth.

StoredIngestion

data class StoredIngestion(val receipt: IngestionReceipt, val revision: Long, val projections: List<AccountProjection>, val ephemeralProjections: List<AccountProjection>)

Committed ingestion result.

StoredRelayCatalogPlan

data class StoredRelayCatalogPlan(val plan: RelayCatalogPlan, val revision: Long)

One committed discovery reconciliation.

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.

SynchronizationPhase

enum SynchronizationPhase : Enum<SynchronizationPhase>

Current Rust-owned synchronization phase.

SynchronizationState

data class SynchronizationState(val phase: SynchronizationPhase, val untilTimestamp: Long, val pageLimit: UInt, val haveCount: UInt, val needCount: UInt, val requestedCount: UInt, val committedCount: UInt)

Redacted progress for the synchronization owned by the active transport run.

TransportAction

data class TransportAction(val runId: String, val actionId: String, val generation: ULong, val kind: TransportActionKind, val configuredUrl: String, val networkUrl: String, val noiseRemoteStaticKey: ByteArray, val textFrame: String, val delayMillis: ULong)

One correlated WebSocket effect for hosts using the low-level transport API.

TransportActionKind

enum TransportActionKind : Enum<TransportActionKind>

Platform effects emitted by the Rust-owned transport state machine.

TransportBatch

data class TransportBatch(val actions: List<TransportAction>, val connectionState: AccountConnectionState, val idle: Boolean, val revision: Long, val typingIndicators: List<TypingIndicator>, val synchronization: SynchronizationState?)

Complete committed transition returned to the Android system executor.

TransportResult

data class TransportResult(val runId: String, val actionId: String, val generation: ULong, val kind: TransportResultKind, val textFrame: String = "")

One result echoed to the Rust-owned transport state machine.

TransportResultKind

enum TransportResultKind : Enum<TransportResultKind>

Typed outcome Android reports for one exact transport action.

Typing

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

Typed ephemeral typing notification.

TypingIndicator

data class TypingIndicator(val conversationId: ConversationId, val author: PublicKey, val expiresAt: Long)

Authenticated remote typing state retained by Rust until expiresAt.

UploadQuality

enum UploadQuality : Enum<UploadQuality>

Portable media-quality preference.

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.