lib/app.cash.nostrino.model

Package-level declarations

Types

data class AmountTag(val amount: Long) : Tag

data class Bolt11Tag(val bolt11: String) : Tag

data class Downvote(val eventId: ByteString, val authorPubKey: PubKey, val tags: List<Tag> = listOf(EventTag(eventId), PubKeyTag(authorPubKey))) : Reaction

Specialised reaction indicating a downvote.

EmojiReact

data class EmojiReact(val emoji: String, val eventId: ByteString, val authorPubKey: PubKey, val tags: List<Tag> = listOf(EventTag(eventId), PubKeyTag(authorPubKey))) : Reaction

Any reaction that isn't an upvote or downvote.

EncryptedDm

data class EncryptedDm(val to: PubKey, val cipherText: CipherText, val tags: List<Tag> = listOf(PubKeyTag(to))) : EventContent

An encrypted direct message. Event kind 4, as defined in nip-04.

Event

data class Event(val id: ByteString, @Json(name = "pubkey") val pubKey: ByteString, @Json(name = "created_at") val createdAt: Instant, val kind: Int, val tags: List<List<String>>, val content: String, val sig: ByteString)

The primitive type understood by relays, as per nip-01

EventContent

interface EventContent

A type that can be signed and converted into an Event

EventDeletion

data class EventDeletion(val message: String = "", val eventIds: Set<ByteString>, val tags: List<Tag> = eventIds.map { EventTag(it) }) : EventContent

An event deletion request message. Event kind 5, as defined in nip-09.

EventTag

data class EventTag(val eventId: ByteString) : Tag

Filter

data class Filter(val ids: Set<String>? = null, val since: Instant? = null, val authors: Set<String>? = null, val kinds: Set<Int>? = null, @Json(name = "#e") val eTags: Set<String>? = null, @Json(name = "#p") val pTags: Set<String>? = null, @Json(name = "#t") val tTags: Set<String>? = null, val limit: Int? = null)

A subscription filter, as defined in nip-01.

HashTag

data class HashTag(val label: String) : Tag

LnUrlTag

data class LnUrlTag(val lnurl: String) : Tag

PreimageTag

data class PreimageTag(val preimage: ByteString) : Tag

PubKeyTag

data class PubKeyTag(val pubKey: PubKey) : Tag

Reaction

sealed class Reaction : EventContent

A reaction to an event. Event kind 7, as defined in nip-25.

RelaysTag

data class RelaysTag(val relays: List<String>) : Tag

Tag

interface Tag

TextNote

data class TextNote(val text: String, val tags: List<Tag> = emptyList()) : EventContent

A text note that can be published via relays. Event kind 1, as defined in nip-01.

Upvote

data class Upvote(val eventId: ByteString, val authorPubKey: PubKey, val tags: List<Tag> = listOf(EventTag(eventId), PubKeyTag(authorPubKey))) : Reaction

Specialised reaction indicating an upvote.

UserMetaData

data class UserMetaData(val name: String? = null, val about: String? = null, val picture: String? = null, val nip05: String? = null, val banner: String? = null, @Json(name = "display_name") val displayName: String? = null, val website: String? = null, val tags: List<Tag> = emptyList()) : EventContent

User metadata (profile). Event kind 0, as defined in nip-01.

ZapReceipt

data class ZapReceipt(val to: PubKey, val eventId: ByteString?, val bolt11: String, val zapRequest: Event, val preimage: ByteString? = null, val tags: List<Tag> = listOfNotNull( PubKeyTag(to), eventId?.let(::EventTag), Bolt11Tag(bolt11), ZapReceiptDescriptionTag(zapRequest), preimage?.let(::PreimageTag), )) : EventContent

Zap receipt. Event kind 9735, as defined in nip-57.

ZapReceiptDescriptionTag

data class ZapReceiptDescriptionTag(val description: Event) : Tag

ZapRequest

data class ZapRequest(val content: String, val relays: List<String>, val amount: Long?, val lnurl: String?, val to: PubKey, val eventId: ByteString?, val tags: List<Tag> = listOfNotNull( RelaysTag(relays), amount?.let(::AmountTag), lnurl?.let(::LnUrlTag), PubKeyTag(to), eventId?.let(::EventTag) )) : EventContent

Zap request. Event kind 9734, as defined in nip-57.

Functions

encrypt

fun SecKey.encrypt(to: PubKey, plainText: String): CipherText