Class NDKZap

constructor

• new NDKZap(args: ZapConstructorParams): NDKZap

• Parameters

  • args: ZapConstructorParams

  Returns NDKZap

ndk

Optional zappedEvent

zappedUser

createZapRequest

• createZapRequest(amount: number, comment?: string, extraTags?: NDKTag[], relays?: string[], signer?: NDKSigner): Promise<null | string>

• Generates a kind:9734 zap request and returns the payment request

  Parameters

  • amount: number

    amount to zap in millisatoshis

  • Optional comment: string

    optional comment to include in the zap request

  • Optional extraTags: NDKTag[]

    optional extra tags to include in the zap request

  • Optional relays: string[]

    optional relays to ask zapper to publish the zap to

  • Optional signer: NDKSigner

  Returns Promise<null | string>

  the payment request

generateZapRequest

• generateZapRequest(amount: number, comment?: string, extraTags?: NDKTag[], relays?: string[], signer?: NDKSigner): Promise<null | {
      event: NDKEvent;
      zapEndpoint: string;
  }>

• Parameters

  • amount: number

  • Optional comment: string

  • Optional extraTags: NDKTag[]

  • Optional relays: string[]

  • Optional signer: NDKSigner

  Returns Promise<null | {
      event: NDKEvent;
      zapEndpoint: string;
  }>

getInvoice

• getInvoice(event: NDKEvent, amount: number, zapEndpoint: string): Promise<null | string>

• Parameters

  • event: NDKEvent

  • amount: number

  • zapEndpoint: string

  Returns Promise<null | string>

getZapEndpoint

• getZapEndpoint(): Promise<undefined | string>

• Returns Promise<undefined | string>