Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.82 KB

07.md

File metadata and controls

33 lines (23 loc) · 1.82 KB
Raw

NIP-07

Webブラウザ向けwindow.nostr機能

draft optional

window.nostrオブジェクトはWebブラウザや拡張機能により作成される。WebサイトやWebアプリケーションは利用可能性を確認した上で、このオブジェクトを利用してもよい。

このオブジェクトは下記のメソッドを定義せねばならない:

async window.nostr.getPublicKey(): string // returns a public key as hex
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.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.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated)
async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertext as specified in nip-44
async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44

拡張機能の作成者への推奨事項

ページの読み込み時にnostrクライアントがwindow.nostrを利用できるようにするには、ChromiumおよびFirefoxの拡張機能の作成者は、拡張機能のマニフェストで"run_at": "document_end"を指定してスクリプトをロードする必要がある。

実装

https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions を参照する。