nips/07.md
alex c840d75ce0 nip-07: add the missing functions
as per conversation in t.me/nostr_protcol

getRelays, nip04.encrypt and nip04.decrypt - these are already implemented
by nos2x and getalby.
2022-12-18 06:29:29 -03:00

1.1 KiB

NIP-07

window.nostr capability for web browsers

draft optional author:fiatjaf

The window.nostr object may be made available by web browsers or extensions and websites or web-apps may make use of it after checking its availability.

That object must define the following methods:

async window.nostr.getPublicKey(): string // returns a public key as hex
async window.nostr.signEvent(event: Event): Event // takes an event object and returns it with the `sig`
async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a map of relay urls to relay policies
async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext+iv as specified in nip-04
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext+iv as specified in nip-04

Implementation

  • nos2x is available as a Chromium extension that provides such capabilities.
  • Alby is a Bitcoin extension that also provides a compatible window.nostr.