nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-12-22 16:35:52 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add nostr.pubkey variable for painless pubkey retrieval.

Browse Source 
The extension sets nostr.pubkey during initialization
so as the client can instantly see if somebody is logged in
or not. This allows the clients to detect if the user had
revoked the permission for reading the pubkey, or changed
to a different pubkey. All without nudging the user.
This commit is contained in:
Laszlo Megyer 2024-11-22 18:48:36 +01:00
parent ef1746dd2c
commit ff1210fb56
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
07.md
View File

@ -8,14 +8,15 @@ NIP-07
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. 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: That object must define the following:
``` ```
async window.nostr.getPublicKey(): string // returns a public key as hex window.nostr.pubkey: string | null // variable set on page load to a public key or null if none authorized
async window.nostr.getPublicKey(): string // returns a public key as hex, sets `window.nostr.pubkey`, too.
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 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
``` ```
Aside from these two basic above, the following functions can also be implemented optionally: Aside from these three 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.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 (deprecated) async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated)