Class HDKIndexAbstract

constructor

• new HDKIndex(type, signingParent, encryptParent): HDKIndex

• Parameters

  • type: HDKIndexType

  • signingParent: HDKey

  • encryptParent: HDKey

  Returns HDKIndex

documents

encryptParent

eventTag

Optional parentDocument

signingParent

type

createDeleteEvent

• createDeleteEvent(doc): Promise<Event<number>>

• Parameters

  • doc: ContentDocument

  Returns Promise<Event<number>>

Abstract createEvent

• createEvent(doc, options?): Promise<Event<number>>

• Parameters

  • doc: ContentDocument

  • Optional options: ContentPublishOptions

  Returns Promise<Event<number>>

Abstract getDocumentKeyset

• getDocumentKeyset(docIndex, event?): DocumentKeyset

• Parameters

  • docIndex: number

  • Optional event: Event<number>

  Returns DocumentKeyset

Abstract getFilters

• getFilters(queryArgs?): Filter[]

• Parameters

  • Optional queryArgs: HDKIndexQueryArgs

  Returns Filter[]

Abstract readEvent

• readEvent(event): Promise<undefined | ContentDocument>

• Converts an encrypted 17761 kind NOSTR Event into a readable ContentDocument.

  Parameters

  • event: Event<number>

    the NOSTR event

  Returns Promise<undefined | ContentDocument>

  a decrypted ContentDocument containing the original NOSTR event.

toJSON

• toJSON(): HDKIndexDTO

• Returns HDKIndexDTO

Abstract verifyEvent

• verifyEvent(doc): boolean

• Parameters

  • doc: ContentDocument

  Returns boolean