2022-05-06 20:54:45 -03: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 15:37:42 -03:00
async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id` , `pubkey` and `sig` and returns it
2022-12-18 06:35:30 -03: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
2023-08-11 13:09:17 -07:00
async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated)
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated)
2023-08-11 17:37:29 -07:00
async window.nostr.nip44.encrypt(pubkey, plaintext, v): string // returns encrypted payload as specified in nip-44
2023-08-11 17:43:58 -07:00
async window.nostr.nip44.decrypt(pubkey, payload): string // takes encrypted payload as specified in nip-44
2022-05-06 20:54:45 -03:00
```
2022-11-27 12:03:46 -03:00
### Implementation
2022-05-06 20:54:45 -03:00
2023-03-13 22:31:25 +02:00
- [horse ](https://github.com/fiatjaf/horse ) (Chrome and derivatives)
2023-02-25 12:23:46 +01:00
- [nos2x ](https://github.com/fiatjaf/nos2x ) (Chrome and derivatives)
2023-05-27 08:44:19 +09:00
- [Alby ](https://getalby.com ) (Chrome and derivatives, Firefox)
2023-02-25 12:23:46 +01:00
- [Blockcore ](https://www.blockcore.net/wallet ) (Chrome and derivatives)
- [nos2x-fox ](https://diegogurpegui.com/nos2x-fox/ ) (Firefox)
2023-02-28 20:36:21 -03:00
- [Flamingo ](https://www.getflamingo.org/ ) (Chrome and derivatives)
2023-05-15 09:30:27 -07:00
- [AKA Profiles ](https://github.com/neilck/aka-extension ) (Chrome, stores multiple keys)
2023-05-20 12:26:46 +08:00
- [TokenPocket ](https://www.tokenpocket.pro/ ) (Android, IOS, Chrome and derivatives)
2023-05-29 15:47:09 +08:00
- [Nostrmo ](https://github.com/haorendashu/nostrmo_faq#download ) (Android, IOS)