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