Welshman

Appearance

Welshman Docs / @welshman/domain / Bolt12ZapReader

Class: Bolt12ZapReader ​

Defined in: domain/src/kinds/Bolt12Zap.ts:162

A reader whose event can be parsed without IO — the common case. parse() returns the reader itself, so callers never await it. Override parse to derive state from the event, returning this.

Extends ​

Constructors ​

Constructor ​

new Bolt12ZapReader(kind, context, event): Bolt12ZapReader

Defined in: domain/src/core/EventReader.ts:25

Parameters ​

kind ​

number

context ​

KindContext

event ​

TrustedEvent

Returns ​

Bolt12ZapReader

Inherited from ​

EventReader.constructor

Properties ​

context ​

readonly context: KindContext

Defined in: domain/src/core/EventReader.ts:27

Inherited from ​

EventReader.context

event ​

readonly event: TrustedEvent

Defined in: domain/src/core/EventReader.ts:28

Inherited from ​

EventReader.event

kind ​

readonly kind: number

Defined in: domain/src/core/EventReader.ts:26

Inherited from ​

EventReader.kind

Methods ​

address() ​

address(): string

Defined in: domain/src/core/EventReader.ts:63

Returns ​

string

Inherited from ​

EventReader.address

amount() ​

amount(): number | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:173

Returns ​

number | undefined

author() ​

author(): string

Defined in: domain/src/core/EventReader.ts:43

Returns ​

string

Inherited from ​

EventReader.author

client() ​

client(): Client | undefined

Defined in: domain/src/core/EventReader.ts:87

Returns ​

Client | undefined

Inherited from ​

EventReader.client

content() ​

content(): string

Defined in: domain/src/core/EventReader.ts:47

Returns ​

string

Inherited from ​

EventReader.content

contentWarning() ​

contentWarning(): boolean

Defined in: domain/src/core/EventReader.ts:79

Returns ​

boolean

Inherited from ​

EventReader.contentWarning

contentWarningReason() ​

contentWarningReason(): string | undefined

Defined in: domain/src/core/EventReader.ts:83

Returns ​

string | undefined

Inherited from ​

EventReader.contentWarningReason

createdAt() ​

createdAt(): number

Defined in: domain/src/core/EventReader.ts:55

Returns ​

number

Inherited from ​

EventReader.createdAt

emojis() ​

emojis(): Emoji[]

Defined in: domain/src/core/EventReader.ts:91

Returns ​

Emoji[]

Inherited from ​

EventReader.emojis

eventId() ​

eventId(): string | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:181

Returns ​

string | undefined

expiration() ​

expiration(): number | undefined

Defined in: domain/src/core/EventReader.ts:75

Returns ​

number | undefined

Inherited from ​

EventReader.expiration

id() ​

id(): string

Defined in: domain/src/core/EventReader.ts:39

Returns ​

string

Inherited from ​

EventReader.id

identifier() ​

identifier(): string | undefined

Defined in: domain/src/core/EventReader.ts:59

Returns ​

string | undefined

Inherited from ​

EventReader.identifier

imeta() ​

imeta(): Imeta[]

Defined in: domain/src/core/EventReader.ts:95

Returns ​

Imeta[]

Inherited from ​

EventReader.imeta

intent() ​

intent(): SignedEvent | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:204

Returns ​

SignedEvent | undefined

offer() ​

offer(): SignedEvent | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:209

Returns ​

SignedEvent | undefined

offers() ​

offers(): string[]

Defined in: domain/src/kinds/Bolt12Zap.ts:214

Returns ​

string[]

parse() ​

parse(): this

Defined in: domain/src/core/EventReader.ts:114

Returns ​

this

Inherited from ​

EventReader.parse

payer() ​

payer(): string | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:168

Returns ​

string | undefined

proof() ​

proof(): string | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:177

Returns ​

string | undefined

protect() ​

protect(): boolean

Defined in: domain/src/core/EventReader.ts:71

Returns ​

boolean

Inherited from ​

EventReader.protect

quotes() ​

quotes(): Quote[]

Defined in: domain/src/core/EventReader.ts:99

Returns ​

Quote[]

Inherited from ​

EventReader.quotes

recipient() ​

recipient(): string | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:163

Returns ​

string | undefined

room() ​

room(): string | undefined

Defined in: domain/src/core/EventReader.ts:67

Returns ​

string | undefined

Inherited from ​

EventReader.room

tags() ​

tags(): string[][]

Defined in: domain/src/core/EventReader.ts:51

Returns ​

string[][]

Inherited from ​

EventReader.tags

target() ​

target(): string | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:194

Returns ​

string | undefined

targetAddress() ​

targetAddress(): string | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:185

Returns ​

string | undefined

targetKind() ​

targetKind(): number | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:189

Returns ​

number | undefined

targetsProfile() ​

targetsProfile(): boolean

Defined in: domain/src/kinds/Bolt12Zap.ts:199

Returns ​

boolean

validate() ​

validate(): Bolt12ZapClaim | undefined

Defined in: domain/src/kinds/Bolt12Zap.ts:225

Runs NIP-B1's nostr-side validation, including that the payer signed both the zap and its intent, and returns undefined on failure. getBolt12ZapPaymentHash is the lightning half, and it reads the claim this returns.

Returns ​

Bolt12ZapClaim | undefined

zapSplits() ​

zapSplits(): ZapSplit[]

Defined in: domain/src/core/EventReader.ts:103

Returns ​

ZapSplit[]

Inherited from ​

EventReader.zapSplits