nips/07.md
Pavan Joshi aa3ac102cf
nip-07 events
add events system in window.nostr
2023-08-08 14:03:09 +05:30

1.9 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, adds `id`, `pubkey` and `sig` and returns it

Aside from these two basic above, the following functions can also be implemented optionally:

async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies
async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04
window.nostr.on(eventName: "accountChanged", listener: () => void): void //subscribes to the event for the specified eventName
window.nostr.off(eventName: "accountChanged", listener: () => void): void // unsubscribes from the event for the specified eventName

Implementation