Skip to content

[New Feature] Derive Nostr privkey / pubkey via NIP-06 #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 73 additions & 11 deletions l10n/messages.pot
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: seedsigner 0.8.5-rc1\n"
"Project-Id-Version: seedsigner 0.8.5\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2025-01-28 13:28-0600\n"
"POT-Creation-Date: 2025-04-23 11:43-0500\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -50,6 +50,27 @@ msgstr ""
msgid "SD card inserted"
msgstr ""

#: src/seedsigner/gui/screens/nostr_screens.py
#: src/seedsigner/views/nostr_views.py src/seedsigner/views/seed_views.py
msgid "Export Nostr Key"
msgstr ""

#. Short for "Next step"
#: src/seedsigner/gui/screens/nostr_screens.py
#: src/seedsigner/gui/screens/seed_screens.py
#: src/seedsigner/views/psbt_views.py src/seedsigner/views/seed_views.py
#: src/seedsigner/views/tools_views.py
msgid "Next"
msgstr ""

#: src/seedsigner/gui/screens/nostr_screens.py
msgid "Public key:"
msgstr ""

#: src/seedsigner/gui/screens/nostr_screens.py
msgid "Private key:"
msgstr ""

#: src/seedsigner/gui/screens/psbt_screens.py
msgid "Review PSBT"
msgstr ""
Expand Down Expand Up @@ -435,13 +456,6 @@ msgstr ""
msgid "Review Message"
msgstr ""

#. Short for "Next step"
#: src/seedsigner/gui/screens/seed_screens.py
#: src/seedsigner/views/psbt_views.py src/seedsigner/views/seed_views.py
#: src/seedsigner/views/tools_views.py
msgid "Next"
msgstr ""

#: src/seedsigner/gui/screens/seed_screens.py
msgid "Confirm Address"
msgstr ""
Expand Down Expand Up @@ -762,6 +776,14 @@ msgstr ""
msgid "BIP-85 child seeds"
msgstr ""

#: src/seedsigner/models/settings_definition.py
msgid "Nostr NIP-06 keys"
msgstr ""

#: src/seedsigner/models/settings_definition.py
msgid "Derive Nostr key from BIP-39 mnemonic"
msgstr ""

#: src/seedsigner/models/settings_definition.py
msgid "Electrum seeds"
msgstr ""
Expand Down Expand Up @@ -794,6 +816,46 @@ msgstr ""
msgid "QR background color"
msgstr ""

#: src/seedsigner/views/nostr_views.py
msgid "Keep keys separate!"
msgstr ""

#: src/seedsigner/views/nostr_views.py
msgid "If this key already secures bitcoin, do not use it as your nostr key!"
msgstr ""

#. Option to export a nostr public key; do not translate "npub".
#: src/seedsigner/views/nostr_views.py
msgid "Public key: npub"
msgstr ""

#. Option to export a nostr public key; "hex" == hexadecimal format.
#: src/seedsigner/views/nostr_views.py
msgid "Public key: hex"
msgstr ""

#. Option to export a nostr private key; do not translate "nsec".
#: src/seedsigner/views/nostr_views.py
msgid "Private key: nsec"
msgstr ""

#. Option to export a nostr private key; "hex" == hexadecimal format.
#: src/seedsigner/views/nostr_views.py
msgid "Private key: hex"
msgstr ""

#: src/seedsigner/views/nostr_views.py
msgid "Nostr Private Key"
msgstr ""

#: src/seedsigner/views/nostr_views.py
msgid "Protect your key!"
msgstr ""

#: src/seedsigner/views/nostr_views.py
msgid "Anyone with your private key has full control of your nostr identity."
msgstr ""

#: src/seedsigner/views/psbt_views.py src/seedsigner/views/seed_views.py
#: src/seedsigner/views/tools_views.py
msgid "Scan a seed"
Expand Down Expand Up @@ -1254,11 +1316,11 @@ msgid "Review SeedQR"
msgstr ""

#: src/seedsigner/views/seed_views.py
msgid "Your transcribed SeedQR successfully scanned and yielded the same seed."
msgid "Your transcribed SeedQR could not be read!"
msgstr ""

#: src/seedsigner/views/seed_views.py
msgid "Your transcribed SeedQR could not be read!"
msgid "Your transcribed SeedQR successfully scanned and yielded the same seed."
msgstr ""

#: src/seedsigner/views/seed_views.py
Expand Down
1 change: 1 addition & 0 deletions src/seedsigner/gui/components.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class GUIConstants:
TESTNET_COLOR = "#00F100"
REGTEST_COLOR = "#00CAF1"
GREEN_INDICATOR_COLOR = "#00FF00"
NOSTR_ACCENT_COLOR = "#dd23ef"

ICON_FONT_NAME__FONT_AWESOME = "Font_Awesome_6_Free-Solid-900"
ICON_FONT_NAME__SEEDSIGNER = "seedsigner-icons"
Expand Down
60 changes: 60 additions & 0 deletions src/seedsigner/gui/screens/nostr_screens.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
from gettext import gettext as _

from dataclasses import dataclass
from seedsigner.gui.components import GUIConstants, TextArea

from seedsigner.gui.screens.screen import ButtonListScreen, ButtonOption, WarningEdgesMixin



"""****************************************************************************
Nostr Key Export
****************************************************************************"""
@dataclass
class BaseNostrKeyDisplayScreen(ButtonListScreen):
"""
Base Screen class for either Nostr pubkey or privkey display.
"""
key: str = None
is_pubkey: bool = True

def __post_init__(self):
# Customize defaults
self.title = _("Export Nostr Key")
self.button_data = [ButtonOption("Next")]
self.is_bottom_list = True

super().__post_init__()

keytype = TextArea(
text=_("Public key:") if self.is_pubkey else _("Private key:"),
is_text_centered=True,
screen_y=self.top_nav.height + GUIConstants.COMPONENT_PADDING
)
self.components.append(keytype)

# npub and nsec are 63 chars; hex format is 64 chars. Break into 4 lines.
chars_per_line = 16
key_str = "\n".join([s for s in [self.key[i:i+chars_per_line] for i in range(0, len(self.key), chars_per_line)]])

key_display = TextArea(
text=key_str,
font_name=GUIConstants.FIXED_WIDTH_FONT_NAME,
font_color=GUIConstants.NOSTR_ACCENT_COLOR,
font_size=GUIConstants.get_button_font_size(), # Intentionally using a bigger font size
is_text_centered=True,
)
key_display.screen_y = keytype.screen_y + keytype.height + 2*GUIConstants.COMPONENT_PADDING
self.components.append(key_display)



class NostrPublicKeyDisplayScreen(BaseNostrKeyDisplayScreen):
pass



@dataclass
class NostrPrivateKeyDisplayScreen(WarningEdgesMixin, BaseNostrKeyDisplayScreen):
status_color: str = GUIConstants.DIRE_WARNING_COLOR
is_pubkey: bool = False
64 changes: 64 additions & 0 deletions src/seedsigner/helpers/nostr.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
from binascii import hexlify
from embit import bip32, bech32
from embit import ec
from seedsigner.models.seed import Seed


NOSTR__PUBKEY_NPUB = "npub"
NOSTR__PUBKEY_HEX = "pubhex"
NOSTR__PRIVKEY_NSEC = "nsec"
NOSTR__PRIVKEY_HEX = "privhex"


def derive_nostr_key(seed: Seed) -> bip32.HDKey:
""" Derive the NIP-06 Nostr key at m/44'/1237'/0'/0/0

Note: NIP-06 mentions the possibility of deriving sibling seeds by incrementing
`account` (i.e. m/44'/1237'/<account>'/0/0) from the same root Seed, but for now
we only support the simplest (`account == 0`) use case.
"""
root = bip32.HDKey.from_seed(seed.seed_bytes)
return root.derive("m/44h/1237h/0h/0/0")



def get_nsec(seed: Seed) -> str:
nostr_root = derive_nostr_key(seed=seed)
converted_bits = bech32.convertbits(nostr_root.secret, 8, 5)
return bech32.bech32_encode(encoding=bech32.Encoding.BECH32, hrp=NOSTR__PRIVKEY_NSEC, data=converted_bits)



def get_npub(seed: Seed) -> str:
nostr_root = derive_nostr_key(seed=seed)
privkey = ec.PrivateKey(secret=nostr_root.secret)
pubkey = privkey.get_public_key().xonly()
converted_bits = bech32.convertbits(pubkey, 8, 5)
return bech32.bech32_encode(encoding=bech32.Encoding.BECH32, hrp=NOSTR__PUBKEY_NPUB, data=converted_bits)



def get_pubkey_hex(seed: Seed) -> str:
nostr_root = derive_nostr_key(seed=seed)
privkey = ec.PrivateKey(secret=nostr_root.secret)
return hexlify(privkey.get_public_key().xonly()).decode()



def get_privkey_hex(seed: Seed) -> str:
nostr_root = derive_nostr_key(seed=seed)
return hexlify(nostr_root.secret).decode()



def get_nostr_key(seed: Seed, format: str = NOSTR__PUBKEY_NPUB) -> str:
if format == NOSTR__PUBKEY_NPUB:
return get_npub(seed)
elif format == NOSTR__PUBKEY_HEX:
return get_pubkey_hex(seed)
elif format == NOSTR__PRIVKEY_NSEC:
return get_nsec(seed)
elif format == NOSTR__PRIVKEY_HEX:
return get_privkey_hex(seed)
else:
raise ValueError(f"Invalid format: {format}")
9 changes: 9 additions & 0 deletions src/seedsigner/models/settings_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@ def map_network_to_embit(cls, network) -> str:
SETTING__CAMERA_ROTATION = "camera_rotation"
SETTING__COMPACT_SEEDQR = "compact_seedqr"
SETTING__BIP85_CHILD_SEEDS = "bip85_child_seeds"
SETTING__NOSTR_NIP06_EXPORT = "nostr_nip06_export"
SETTING__ELECTRUM_SEEDS = "electrum_seeds"
SETTING__MESSAGE_SIGNING = "message_signing"
SETTING__PRIVACY_WARNINGS = "privacy_warnings"
Expand Down Expand Up @@ -640,6 +641,14 @@ class SettingsDefinition:
visibility=SettingsConstants.VISIBILITY__ADVANCED,
default_value=SettingsConstants.OPTION__DISABLED),

SettingsEntry(category=SettingsConstants.CATEGORY__FEATURES,
attr_name=SettingsConstants.SETTING__NOSTR_NIP06_EXPORT,
abbreviated_name="nip06",
display_name=_mft("Nostr NIP-06 keys"),
help_text=_mft("Derive Nostr key from BIP-39 mnemonic"),
visibility=SettingsConstants.VISIBILITY__ADVANCED,
default_value=SettingsConstants.OPTION__DISABLED),

SettingsEntry(category=SettingsConstants.CATEGORY__FEATURES,
attr_name=SettingsConstants.SETTING__ELECTRUM_SEEDS,
abbreviated_name="electrum",
Expand Down
Loading