mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-09 22:09:06 -05:00
c840d75ce0
as per conversation in t.me/nostr_protcol getRelays, nip04.encrypt and nip04.decrypt - these are already implemented by nos2x and getalby.
25 lines
1.1 KiB
Markdown
25 lines
1.1 KiB
Markdown
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 and returns it with the `sig`
|
|
async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a map of relay urls to relay policies
|
|
async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext+iv as specified in nip-04
|
|
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext+iv as specified in nip-04
|
|
```
|
|
|
|
### Implementation
|
|
|
|
- [nos2x](https://github.com/fiatjaf/nos2x) is available as a Chromium extension that provides such capabilities.
|
|
- [Alby](https://getalby.com) is a Bitcoin extension that also provides a compatible `window.nostr`.
|