https://github.com/diegogurpegui/nos2x-fox

nostr signer extension for Firefox
https://github.com/diegogurpegui/nos2x-fox

browser-extension firefox-addon nostr

Last synced: about 20 hours ago
JSON representation

nostr signer extension for Firefox

• Host: GitHub
• URL: https://github.com/diegogurpegui/nos2x-fox
• Owner: diegogurpegui
• License: unlicense
• Created: 2022-12-27T20:57:26.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-05T01:04:01.000Z (14 days ago)
• Last Synced: 2025-01-05T01:26:28.140Z (14 days ago)
• Topics: browser-extension, firefox-addon, nostr
• Language: TypeScript
• Homepage: https://diegogurpegui.com/nos2x-fox/
• Size: 2.36 MB
• Stars: 81
• Watchers: 6
• Forks: 17
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](src/assets/logo/logotype.png)

# nos2x-fox (nos2x for Firefox)

notes and other stuff signed by an extension

This is a fork from https://github.com/fiatjaf/nos2x focused on Firefox and related browsers.

## Nostr Signer Extension

This allows you to sign [Nostr](https://github.com/fiatjaf/nostr) events on web-apps without having to give them your keys.

It provides a `window.nostr` object which has the following methods:

```javascript

async window.nostr.getPublicKey(): string // returns your public key as hex

async window.nostr.signEvent(event): Event // returns the full event object signed

async window.nostr.getRelays(): { [url: string]: RelayPolicy } // returns a map of relays

async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext+iv as specified in nip04

async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext+iv as specified in nip04

async window.nostr.nip44.encrypt(pubkey, plaintext): string // takes pubkey, plaintext, returns ciphertext as specified in nip-44

async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes pubkey, ciphertext, returns plaintext as specified in nip-44

```

## Install

* By yourself from file: look into [Releases](https://github.com/diegogurpegui/nos2x-fox/releases)

* From the site [Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/nos2x-fox/)

## Develop

To run the plugin from this code:

```

$ git clone https://github.com/diegogurpegui/nos2x-fox

$ cd nos2x-fox

$ yarn install

$ yarn run build

```

After you build the extension, follow these steps:

1. Open Firefox

2. Go to about:debugging

3. Click on "This Firefox" on the left

4. Click on "Load Temporary Add-on..."

5. Select any file from the `dist/` folder of the extension

## Screenshots

![](screenshots/screenshot_popup.png)

![](screenshots/screenshot_options.png)

![](screenshots/screenshot_prompt.png)

---

## License and Credits

LICENSE: public domain.

Original work by [fiatjaf](https://github.com/fiatjaf).

Design taken from [Flydexo](https://github.com/Flydexo). See https://github.com/fiatjaf/nos2x/pull/15

Icons from [IonIcons](https://ionic.io/ionicons).