nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-09-19 11:43:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
c5d2135158
nips/07.md

1.2 KiB
Raw Blame History

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`

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

Implementation

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