Class NDKNip07Signer

constructor

• new NDKNip07Signer(waitTimeout?: number): NDKNip07Signer

• Parameters

  • waitTimeout: number = 1000

    The timeout in milliseconds to wait for the NIP-07 to become available

  Returns NDKNip07Signer

nip04Queue

blockUntilReady

• blockUntilReady(): Promise<NDKUser>

• Blocks until the signer is ready and returns the associated NDKUser.

  Returns Promise<NDKUser>

  A promise that resolves to the NDKUser instance.

decrypt

• decrypt(sender: NDKUser, value: string, type?: ENCRYPTION_SCHEMES): Promise<string>

• Decrypts the given value.

  Parameters

  • sender: NDKUser
  • value: string
  • type: ENCRYPTION_SCHEMES = DEFAULT_ENCRYPTION_SCHEME

    The encryption scheme to use. Defaults to "nip04".

  Returns Promise<string>

encrypt

• encrypt(recipient: NDKUser, value: string, type?: ENCRYPTION_SCHEMES): Promise<string>

• Encrypts the given Nostr event for the given recipient.

  Parameters

  • recipient: NDKUser

    The recipient of the encrypted value.
  • value: string

    The value to be encrypted.
  • type: ENCRYPTION_SCHEMES = DEFAULT_ENCRYPTION_SCHEME

    The encryption scheme to use. Defaults to "nip04".

  Returns Promise<string>

nip04Decrypt

• nip04Decrypt(sender: NDKUser, value: string): Promise<string>

• Parameters

  • sender: NDKUser
  • value: string

  Returns Promise<string>

  Deprecated

  use nip44Decrypt instead

nip04Encrypt

• nip04Encrypt(recipient: NDKUser, value: string): Promise<string>

• Parameters

  • recipient: NDKUser
  • value: string

  Returns Promise<string>

  Deprecated

  use nip44Encrypt instead

nip44Decrypt

• nip44Decrypt(sender: NDKUser, value: string): Promise<string>

• Parameters

  • sender: NDKUser
  • value: string

  Returns Promise<string>

  Deprecated

  use nip44Decrypt instead

nip44Encrypt

• nip44Encrypt(recipient: NDKUser, value: string): Promise<string>

• Parameters

  • recipient: NDKUser
  • value: string

  Returns Promise<string>

  Deprecated

  use nip44Encrypt instead

relays

• relays(ndk?: default): Promise<NDKRelay[]>

• Getter for the preferred relays.

  Parameters

  • Optionalndk: default

  Returns Promise<NDKRelay[]>

  A promise containing a simple map of preferred relays and their read/write policies.

sign

• sign(event: NostrEvent): Promise<string>

• Signs the given Nostr event.

  Parameters

  • event: NostrEvent

    The Nostr event to be signed.

  Returns Promise<string>

  The signature of the signed event.

  Throws

  Error if the NIP-07 is not available on the window object.

user

• user(): Promise<NDKUser>

• Getter for the user property.

  Returns Promise<NDKUser>

  The NDKUser instance.