2022-05-06 23:54:45 +00:00
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
2023-01-15 18:37:42 +00:00
async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id` , `pubkey` and `sig` and returns it
2022-12-18 09:35:30 +00:00
```
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
2022-05-06 23:54:45 +00:00
```
2022-11-27 15:03:46 +00:00
### Implementation
2022-05-06 23:54:45 +00:00
2023-03-13 20:31:25 +00:00
- [horse ](https://github.com/fiatjaf/horse ) (Chrome and derivatives)
2023-02-25 11:23:46 +00:00
- [nos2x ](https://github.com/fiatjaf/nos2x ) (Chrome and derivatives)
- [Alby ](https://getalby.com ) (Chrome and derivatives, Firefox, Safari)
- [Blockcore ](https://www.blockcore.net/wallet ) (Chrome and derivatives)
- [nos2x-fox ](https://diegogurpegui.com/nos2x-fox/ ) (Firefox)
2023-02-28 23:36:21 +00:00
- [Flamingo ](https://www.getflamingo.org/ ) (Chrome and derivatives)
