Class EventPublisher

Index

Constructors

Properties

#miner? #pow? #pubKey #signer

Accessors

Constructors

constructor

new EventPublisher(signer, pubKey): EventPublisher
Parameters
- signer: EventSigner
- pubKey: string
Returns EventPublisher
- Defined in packages/system/src/event-publisher.ts:39

Properties

`Private` `Optional` #miner

#miner?: PowMiner

`Private` `Optional` #pow

#pow?: number

`Private` #pubKey

#pubKey: string

`Private` #signer

#signer: EventSigner

Accessors

pubKey

get pubKey(): string
Returns string
- Defined in packages/system/src/event-publisher.ts:69

Methods

`Private` #eb

#eb(k): EventBuilder
Parameters
- k: EventKind
Returns EventBuilder
- Defined in packages/system/src/event-publisher.ts:83

`Private` #sign

#sign(eb): Promise<NostrEvent>
Parameters
- eb: EventBuilder
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:88

appData

appData(data, id): Promise<NostrEvent>
Parameters
- data: object
- id: string
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:332

bookmarks

bookmarks(notes): Promise<NostrEvent>
Build a categorized bookmarks event with a given label
Parameters
- notes: ToNostrEventTag[]
  List of bookmarked links
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:140

contactList

contactList(tags): Promise<NostrEvent>
Parameters
- tags: [string, string][]
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:260

createUnsigned

createUnsigned(kind, content, fnHook): NotSignedNostrEvent
Create an unsigned gossip message
Parameters
- kind: EventKind
- content: string
- fnHook: EventBuilderHook
Returns NotSignedNostrEvent
- Defined in packages/system/src/event-publisher.ts:369

decryptDm

decryptDm(note): Promise<string>
Parameters
- note: NostrEvent
Returns Promise<string>
- Defined in packages/system/src/event-publisher.ts:302

decryptGeneric

decryptGeneric(content, from): Promise<string>
Generic decryption using NIP-23 payload scheme
Parameters
- content: string
- from: string
Returns Promise<string>
- Defined in packages/system/src/event-publisher.ts:288

delete

delete(id): Promise<NostrEvent>
Delete an event (NIP-09)
Parameters
- id: string
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:269

generic

generic(fnHook): Promise<NostrEvent>
Parameters
- fnHook: EventBuilderHook
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:325

giftWrap

giftWrap(inner, explicitP?, powTarget?, powMiner?): Promise<NostrEvent>
NIP-59 Gift Wrap event with ephemeral key
Parameters
- inner: NostrEvent
- Optional explicitP: string
- Optional powTarget: number
- Optional powMiner: PowMiner
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:342

metadata

metadata(obj): Promise<NostrEvent>
Parameters
- obj: UserMetadata
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:148

muted

muted(pub, priv): Promise<NostrEvent>
Build a mute list event using lists of pubkeys
Parameters
- pub: string[]
  Public mute list
- priv: string[]
  Private mute list
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:112

nip42Auth

nip42Auth(challenge, relay): Promise<NostrEvent>
Parameters
- challenge: string
- relay: string
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:100

nip4Decrypt

nip4Decrypt(content, otherKey): Promise<string>
Parameters
- content: string
- otherKey: string
Returns Promise<string>
- Defined in packages/system/src/event-publisher.ts:96

nip4Encrypt

nip4Encrypt(content, otherKey): Promise<string>
Parameters
- content: string
- otherKey: string
Returns Promise<string>
- Defined in packages/system/src/event-publisher.ts:92

note

note(msg, fnExtra?): Promise<NostrEvent>
Create a basic text note
Parameters
- msg: string
- Optional fnExtra: EventBuilderHook
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:157

pinned

pinned(notes): Promise<NostrEvent>
Build a pin list event using lists of event links
Parameters
- notes: ToNostrEventTag[]
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:128

pow

pow(target, miner?): EventPublisher
Create a copy of this publisher with PoW
Parameters
- target: number
- Optional miner: PowMiner
Returns EventPublisher
- Defined in packages/system/src/event-publisher.ts:76

react

react(evRef, content?): Promise<NostrEvent>
Parameters
- evRef: NostrEvent
- content: string = "+"
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:229

relayList

relayList(relays): Promise<NostrEvent>
Parameters
- relays: FullRelaySettings[] | Record<string, RelaySettings>
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:237

reply

reply(replyTo, msg, fnExtra?): Promise<NostrEvent>
Reply to a note
Parameters
- replyTo: TaggedNostrEvent
- msg: string
- Optional fnExtra: EventBuilderHook
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:197

repost

repost(note): Promise<NostrEvent>
Repost a note (NIP-18)
Parameters
- note: NostrEvent
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:278

sealRumor

sealRumor(inner, toKey): Promise<NostrEvent>
Create sealed rumor
Parameters
- inner: NotSignedNostrEvent
- toKey: string
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:381

sendDm

sendDm(content, to): Promise<NostrEvent>
Parameters
- content: string
- to: string
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:318

supports

supports(t): boolean
Parameters
- t: string
Returns boolean
- Defined in packages/system/src/event-publisher.ts:65

unsealRumor

unsealRumor(inner): Promise<NostrEvent>
Unseal rumor
Parameters
- inner: NostrEvent
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:390

unwrapGift

unwrapGift(gift): Promise<NostrEvent>
Parameters
- gift: NostrEvent
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:361

zap

zap(amount, author, relays, note?, msg?, fnExtra?): Promise<NostrEvent>
Create a zap request event for a given target event/profile
Parameters
- amount: number
  Millisats amout!
- author: string
  Author pubkey to tag in the zap
- relays: string[]
- Optional note: NostrLink
  Note Id to tag in the zap
- Optional msg: string
  Custom message to be included in the zap
- Optional fnExtra: EventBuilderHook
Returns Promise<NostrEvent>
- Defined in packages/system/src/event-publisher.ts:172

`Static` nip7

nip7(): Promise<undefined | EventPublisher>
Create a NIP-07 EventPublisher

Returns Promise<undefined | EventPublisher>
- Defined in packages/system/src/event-publisher.ts:47

`Static` privateKey

privateKey(privateKey): EventPublisher
Create an EventPublisher for a private key
Parameters
- privateKey: string
Returns EventPublisher
- Defined in packages/system/src/event-publisher.ts:60

Generated using TypeDoc