nips/07.md

40 lines
2.2 KiB
Markdown
Raw Normal View History

2022-05-06 19:54:45 -04:00
NIP-07
======
`window.nostr` capability for web browsers
------------------------------------------
2023-02-10 23:51:12 -05:00
`draft` `optional` `author:fiatjaf` `author:ursuscamp`
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-02-10 23:51:12 -05:00
async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id`, `pubkey`, `sig`, and optional `delegation` tag 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
2022-05-06 19:54:45 -04:00
```
2023-02-10 23:51:12 -05:00
### NIP-26 Considerations
Delegation can be supported in an extension by allowing the user to create a delegatee identity and storing the information necessary to construct the `delegation` tag, such as the signed token. There is no need for the extension to store the delegator's private key.
When operating with a delegated identity, an extension must return the _delegator's_ public key from the `getPublicKey` method, so that the user may see their normal feed upon login. Additionally, during `signEvent`, the extension must modify the event by inserting the _delegatee's_ `pubkey`, append a valid `delegation` tag to the end of the tags list and recalculate the event `id`, prior to signing the event.
The client, upon receiving the returned event, need only check for the presence of a `delegation` tag to determine how to handle the event. The client must accept the `id`, `pubkey`, `sig` and `delegation` tag from the signed delegation event.
2022-11-27 10:03:46 -05:00
### Implementation
2022-05-06 19:54:45 -04:00
- [nos2x](https://github.com/fiatjaf/nos2x)
- [Alby](https://getalby.com)
- [Blockcore](https://www.blockcore.net/wallet)
- [nos2x-fox](https://diegogurpegui.com/nos2x-fox/)
2023-02-10 23:51:12 -05:00
- [Nostore](https://github.com/ursuscamp/nostore)