clone

every nostr nip as a chapter of an illustrated, early-2000s printed game manual

main
nip.guide / source-nips / 07.md
07.md 1.5K rendered
1NIP-072======34`window.nostr` capability for web browsers5------------------------------------------67`draft` `optional`89The `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.1011That object must define the following methods:1213```14async window.nostr.getPublicKey(): string // returns a public key as hex15async window.nostr.signEvent(event: { created_at: number, kind: number, tags: string[][], content: string }): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it16```1718Aside from these two basic above, the following functions can also be implemented optionally:19```20async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated)21async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated)22async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertext as specified in nip-4423async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-4424```2526### Recommendation to Extension Authors27To make sure that the `window.nostr` is available to nostr clients on page load, the authors who create Chromium and Firefox extensions should load their scripts by specifying `"run_at": "document_end"` in the extension's manifest.282930### Implementation3132See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions.