Softchat/com.softcose.softchat.protocol/SoftchatIdentity

SoftchatIdentity

class SoftchatIdentity

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

Import is synchronous and copies the caller's bytes into Rust. The caller should clear its own ByteArray after import returns. Keep the identity in an ordinary val for the authenticated session; it is not a closeable resource and does not require use. The generated native owner is reclaimed automatically when this object becomes unreachable.

erase is an optional security action for logout or early key removal. It waits for native work already in flight, is idempotent, and makes later calls fail with SoftchatException.IdentityErased. Operations and erasure are safe to invoke from different JVM or Android threads.

Phase 1 operations are synchronous CPU work. No coroutine dependency is introduced merely to wrap them; applications choose their own dispatcher when moving work off the Android main thread.

Types

object Companion

Import constructors for local identities.

Properties

val publicKey: NostrPublicKey

This identity's canonical public key.

Functions

createAppDataSync

fun SoftchatIdentity.createAppDataSync(createdAt: Long, context: AppDataContext, json: String): AppDataSync

Create directly signed and self-encrypted kind-30079 data.

createApplicationData

fun SoftchatIdentity.createApplicationData(createdAt: Long, identifier: String, content: String): ApplicationData

Create one directly signed generic NIP-78 value.

createChatMessage

fun SoftchatIdentity.createChatMessage(draft: ChatMessageDraft): ChatMessage

Create a complete canonical message through the retained identity.

fun SoftchatIdentity.createDeletion(participants: List<NostrPublicKey>, eventIds: List<NostrEventId>, reason: String = "", createdAt: Long): Deletion

Create a canonical private deletion request.

fun SoftchatIdentity.createEdit(participants: List<NostrPublicKey>, originalEventId: NostrEventId, content: String, emojiTags: List<List<String>> = emptyList(), createdAt: Long): Edit

Create a canonical text-and-emoji edit.

createFollowList

fun SoftchatIdentity.createFollowList(createdAt: Long, contacts: List<Contact>): FollowList

Create one canonical private author-copy contact list.

createNip17TextMessage

fun createNip17TextMessage(recipient: NostrPublicKey, createdAt: Long, content: String): Nip17TextMessage

Create one minimal one-to-one NIP-17 text-message rumor.

createNip42Authentication

fun SoftchatIdentity.createNip42Authentication(challenge: String, relayUrl: String, createdAt: Long): SignedNostrEvent

Create a NIP-42 authentication event bound to one relay challenge.

createNip98Authorization

fun SoftchatIdentity.createNip98Authorization(method: String, url: String, payload: ByteArray?, createdAt: Long): HttpAuthorizationPlan

Create a NIP-98 authorization plan bound to one exact HTTP request.

fun SoftchatIdentity.createReaction(participants: List<NostrPublicKey>, parentId: NostrEventId, parentAuthor: NostrPublicKey, parentKind: NostrEventKind, reaction: String, customEmojiUrl: String? = null, createdAt: Long): Reaction

Create a canonical private reaction.

fun createRumor(draft: NostrEventDraft): NostrRumor

Create one unsigned rumor authored by this identity.

fun SoftchatIdentity.createSubject(draft: SubjectDraft): Subject

Create a canonical group-subject update.

fun SoftchatIdentity.createTyping(participants: List<NostrPublicKey>, createdAt: Long): Typing

Create an ephemeral typing notification.

createUserMetadata

fun SoftchatIdentity.createUserMetadata(draft: UserMetadataDraft): UserMetadata

Create canonical private kind-0 user metadata.

fun decrypt(message: EncryptedMessage): String

Authenticate and decrypt one received message as UTF-8.

decryptAppDataSync

fun SoftchatIdentity.decryptAppDataSync(event: SignedNostrEvent): AppDataSync

Authenticate and decrypt one self-authored kind-30079 event.

fun encrypt(recipient: NostrPublicKey, plaintext: String): EncryptedMessage

Encrypt one non-empty UTF-8 message for recipient.

fun erase()

Irreversibly erase native secret state before normal reclamation.

fun giftWrap(recipient: NostrPublicKey, rumor: NostrRumor, kind: Nip59EnvelopeKind, now: Long): SignedNostrEvent

Create one fresh NIP-59 envelope for exactly one recipient.

fun sign(draft: NostrEventDraft): SignedNostrEvent

Sign one explicit NIP-01 event draft.

open override fun toString(): String

Return a description that never includes secret key material.

fun unwrapGiftWrap(outer: SignedNostrEvent): UnwrappedNip59Envelope

Authenticate every NIP-59 layer and return the enclosed rumor.