nips/07.md

38 lines
1.9 KiB
Markdown
Raw Normal View History

2022-05-06 19:54:45 -04: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
async window.nostr.signEvent(event: Event): 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
window.nostr.on(eventName: "accountChanged", listener: () => void): void //subscribes to the event for the specified eventName
window.nostr.off(eventName: "accountChanged", listener: () => void): void // unsubscribes from the event for the specified eventName
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)
- [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)