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: { created_at: number, kind: number, tags: string[][], content: string }): 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
- horse (Chrome and derivatives)
- nos2x (Chrome and derivatives)
- Alby (Chrome and derivatives, Firefox)
- Blockcore (Chrome and derivatives)
- nos2x-fox (Firefox)
- Flamingo (Chrome and derivatives)
- AKA Profiles (Chrome, stores multiple keys)
- TokenPocket (Android, IOS, Chrome and derivatives)
- Nostrmo (Android, IOS)
- Spring Browser (Android)
- nodestr (NodeJS polyfill)