2022-05-06 19:54:45 -04:00
NIP-07
======
`window.nostr` capability for web browsers
------------------------------------------
2023-11-15 19:42:51 -05:00
`draft` `optional`
2022-05-06 19:54:45 -04:00
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-10-20 16:56:29 -04:00
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
2022-12-18 04:35:30 -05: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 19:54:45 -04:00
```
2022-11-27 10:03:46 -05:00
### Implementation
2022-05-06 19:54:45 -04:00
2023-03-13 16:31:25 -04:00
- [horse ](https://github.com/fiatjaf/horse ) (Chrome and derivatives)
2023-02-25 06:23:46 -05:00
- [nos2x ](https://github.com/fiatjaf/nos2x ) (Chrome and derivatives)
2023-05-26 19:44:19 -04:00
- [Alby ](https://getalby.com ) (Chrome and derivatives, Firefox)
2023-02-25 06:23:46 -05:00
- [Blockcore ](https://www.blockcore.net/wallet ) (Chrome and derivatives)
- [nos2x-fox ](https://diegogurpegui.com/nos2x-fox/ ) (Firefox)
2023-02-28 18:36:21 -05:00
- [Flamingo ](https://www.getflamingo.org/ ) (Chrome and derivatives)
2023-05-15 12:30:27 -04:00
- [AKA Profiles ](https://github.com/neilck/aka-extension ) (Chrome, stores multiple keys)
2023-05-20 00:26:46 -04:00
- [TokenPocket ](https://www.tokenpocket.pro/ ) (Android, IOS, Chrome and derivatives)
2023-05-29 03:47:09 -04:00
- [Nostrmo ](https://github.com/haorendashu/nostrmo_faq#download ) (Android, IOS)
2023-10-10 13:12:21 -04:00
- [Spring Browser ](https://spring.site ) (Android)
2023-10-19 08:27:56 -04:00
- [nodestr ](https://github.com/lightning-digital-entertainment/nodestr ) (NodeJS polyfill)
2023-11-01 08:55:45 -04:00
- [Nostore ](https://apps.apple.com/us/app/nostore/id1666553677 ) (Safari on iOS/MacOS)
2023-11-30 05:38:48 -05:00
- [OneKey ](https://onekey.so/ ) (Android, IOS, Chrome and derivatives)
