Class NDKZapper

constructor

• new NDKZapper(target: NDKEvent | NDKUser, amount: number, unit?: string, comment?: string, ndk?: default, tags?: NDKTag[], signer?: NDKSigner): NDKZapper

• Parameters

  • target: NDKEvent | NDKUser
  • amount: number
  • unit: string = "msat"
  • Optionalcomment: string
  • Optionalndk: default
  • Optionaltags: NDKTag[]
  • Optionalsigner: NDKSigner

  Returns NDKZapper

amount

Optionalcomment

maxRelays

ndk

OptionalonCashuPay

OptionalonComplete

OptionalonLnPay

Optionalsigner

Optionaltags

target

unit

OptionalzapMethod

getLnInvoice

• getLnInvoice(zapRequest: NDKEvent, amount: number, data: NDKLnUrlData): Promise<null | string>

• Gets a bolt11 for a nip57 zap

  Parameters

  • zapRequest: NDKEvent
  • amount: number
  • data: NDKLnUrlData

  Returns Promise<null | string>

getZapMethods

• getZapMethods(ndk: default, recipient: string): Promise<NDKZapMethodInfo[]>

• Gets the zap method that should be used to zap a pubbkey

  Parameters

  • ndk: default
  • recipient: string

  Returns Promise<NDKZapMethodInfo[]>

getZapSplits

• getZapSplits(): NDKZapSplit[]

• Returns NDKZapSplit[]

relays

• relays(pubkey: string): Promise<string[]>

• Parameters

  • pubkey: string

  Returns Promise<string[]>

  the relays to use for the zap request

zap

• zap(): Promise<Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>>

• Initiate zapping process

  Returns Promise<Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>>

zapSplit

• zapSplit(split: NDKZapSplit): Promise<undefined | NDKPaymentConfirmation>

• Parameters

  • split: NDKZapSplit

  Returns Promise<undefined | NDKPaymentConfirmation>