Introduce Nostr #4436

ibz · 2024-12-10T12:41:52Z

This PR adds Nostr support to the Trezor firmware, trezorlib and trezorctl.

Firmware

The Trezor firmware accepts the NostrGetPubkey and NostrSignEvent messages, as defined in common/protob/messages-nostr.proto.

To avoid adding complexity to the firmware, it does not parse the event JSON. The event needs to be parsed beforehand and its individual fields passed via the protobuf message. The return value contains the pubkey, event ID and signature, which need to be added back to the JSON by the caller before forwarding the event to relays.

UI

A simple UI exists to confirm the event being signed on your Trezor's screen. It will be improved later, but for now it just shows all the fields of the event being signed:

Trezor Safe 5

Main screen shows the event kind and the content:

From the menu you can view the created_at and the tags:

Trezor Safe 3

Trezor Model T

trezorctl

trezorctl accepts the nostr get-pubkey and nostr sign-event commands which correspond to the protobuf messages described above.

Note: by passing --account (which defaults to 0 - the "first" account) to trezorctl nostr get-pubkey or trezorctl nostr sign-event you can generate a virtually infinite amount of Nostr keypairs from your Trezor - all derived from your seed phrase using the m/44'/1237'/<account>'/0/0 derivation path, as defined by NIP-06.

get-pubkey

Example:

ibz@localhost:~/dev/trezor-firmware$ trezorctl nostr get-pubkey

Output:

pubkey: 2dc0dd32b499f7bd428156334c3431893c18e6016cf1bf00187d76513368dba7

sign-event

trezorctl nostr sign-event will parse the event JSON, send the NostrSignEvent to the Trezor device and re-assemble the event JSON with the id, pubkey and sig obtained from the Trezor.

Example:

ibz@localhost:~/dev/trezor-firmware$ trezorctl nostr sign-event "{\"kind\": 1, \"created_at\": 1733917737, \"tags\": [[\"e\", \"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36\", \"wss://nostr.example.com\"], [\"p\", \"f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca\"], [\"a\", \"30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd\", \"wss://nostr.example.com\"], [\"alt\", \"reply\"]], \"content\": \"Hello world\"}"

Output:

signed_event: {"kind": 1, "created_at": 1733917737, "tags": [["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], ["alt", "reply"]], "content": "Hello world", "id": "c2ea8f08093caebf6d73bfe4edbb7e8825bac8eb4308ab634e23161db18b78f8", "pubkey": "2dc0dd32b499f7bd428156334c3431893c18e6016cf1bf00187d76513368dba7", "sig": "4176eaa45730a617f7393ba53df009278504911b3b30d35e125cb1c0f0d1e92102f468705eaed7d3ae5bb3bb4267d9411f0184a7ab6c451110553c2fca97b39c"}

github-actions · 2024-12-10T12:49:32Z

core UI changes	device test	click test	persistence test
T2T1 Model T	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3B1 Safe 3	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3T1 Safe 5	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
All	main(screens)

prusnak · 2024-12-11T17:43:38Z

We should check that the address_n provided to NostrGetPubkey and NostrSignEvent matches m/44'/1237'/<account>'/0/0 and fail if it does not.

Also I prefer changing the CLI interface from using --address to using --account where default account is 0 (see below).

Otherwise great work! 🎉

common/protob/messages.proto

python/src/trezorlib/cli/nostr.py

tests/device_tests/nostr/test_nostr.py

prusnak · 2024-12-12T13:29:14Z

core/src/apps/bitcoin/keychain.py

@@ -91,6 +91,9 @@ class MsgWithAddressScriptType(Protocol):
 # SLIP-44 coin type for all Testnet coins
 SLIP44_TESTNET = const(1)

+# SLIP-44 "coin type" for Nostr
+SLIP44_NOSTR = const(1237)


It seems this is not used anywhere.

prusnak · 2024-12-12T13:33:02Z

core/src/apps/nostr/sign_event.py

+    content = msg.content
+
+    node = keychain.derive(address_n)
+    pk = node.public_key()[-32:]


Can we do this? Don't we care about the public key parity? Or does nostr use x-only keys?

Can we do this? Don't we care about the public key parity? Or does nostr use x-only keys?

From what I understand, Nostr uses X-only keys, indeed.

But it is not guaranteed that keychain.derive returns an x-only key, right?
I think we need to convert the key if a non x-only key is returned.

ibz · 2024-12-18T11:23:52Z

We should check that the address_n provided to NostrGetPubkey and NostrSignEvent matches m/44'/1237'/<account>'/0/0 and fail if it does not.

Yup! dc1a257#diff-3dd8aea4110592e07746c9d3233736246c7083e001c9d29db7c1b03f7423f93bR19

obrusvit

Some points for discussion.

common/protob/messages-nostr.proto

core/src/apps/nostr/sign_event.py

[no changelog]

matejcik · 2025-01-13T09:53:55Z

core/.changelog.d/4160.added

@@ -0,0 +1 @@
+Add Nostr support.


pls mark it somehow so that we know that it's debug-only

matejcik · 2025-01-13T09:55:26Z

core/src/apps/nostr/__init__.py

@@ -0,0 +1,5 @@
+from apps.common.paths import PATTERN_BIP44


first entry here should be something like

if not __debug__: from trezor.utils import halt halt("disabled in production mode")

see apps/benchmark/__init__.py

matejcik · 2025-01-13T09:56:16Z

core/src/apps/nostr/get_pubkey.py

+
+
+@auto_keychain(__name__)
+async def get_pubkey(msg: NostrGetPubkey, keychain: Keychain) -> NostrPubkey:


aside: there's no showing the Nostr key on screen, will that be added in the future? if not, this is useless because you can get the same pubkey via GetPublicKey

matejcik · 2025-01-13T09:58:24Z

core/src/trezor/wire/__init__.py

@@ -95,6 +95,7 @@ async def handle_session(iface: WireInterface) -> None:
            except Exception as exc:
                # Log and ignore. The session handler can only exit explicitly in the
                # following finally block.
+                do_not_restart = True


please remove this change.

(if there's a reason you want this, please make a separate issue and a separate PR, this is nothing to do with Nostr)

matejcik · 2025-01-13T09:59:10Z

python/src/trezorlib/mapping.py

@@ -62,7 +62,9 @@ def encode(self, msg: protobuf.MessageType) -> Tuple[int, bytes]:
        """
        wire_type = self.class_to_type_override.get(type(msg), msg.MESSAGE_WIRE_TYPE)
        if wire_type is None:
-            raise ValueError("Cannot encode class without wire type")
+            raise ValueError(


make a separate commit for this one

matejcik · 2025-01-13T10:11:59Z

tests/device_tests/nostr/test_nostr.py

+
+
+@pytest.mark.setup_client(mnemonic=LEAD_MONKEY_MNEMONIC)
+def test_sign_event_lead_monkey(client: Client):


there's a better way to write these tests:

LEAD_MONKEY = pytest.mark.setup_client(...) WHAT_BLEAK = pytest.mark.setup_client(...) VECTORS = ( # pubkey_hex pytest.param("cafecacebeef", mark=LEAD_MONKEY), pytest.param(...) ) @pytest.mark.parametrize("pubkey_hex", VECTORS) def test_get_pubkey(client, pubkey_hex): ...

dtto for sign_event except i'd prefer also hardcoding the signature bytes, in addition to verifying

matejcik · 2025-01-13T10:12:42Z

tests/device_tests/nostr/test_nostr.py

+    response = nostr.sign_event(
+        client,
+        event=json.dumps(
+            {"created_at": created_at, "kind": kind, "tags": tags, "content": content}


instead, make a static event definition with a fixed time etc. on top level. we want the tests to be deterministic if we at all can

matejcik · 2025-01-13T10:13:35Z

python/src/trezorlib/nostr.py

+    n: "Address",
+    event: AnyStr,
+) -> "MessageType":
+    event_json = json.loads(event)


if you want a structured dict in, pass it in as a dict, not as a string. Let the caller do their own json.loads if they want to. for bonus points, use TypedDict.
(wondering if we should instead introduce a dataclass for the parameters, or perhaps use the protobuf message directly? given that we're returning the corresponding protobuf instance too)

matejcik · 2025-01-13T10:14:59Z

python/src/trezorlib/nostr.py

+
+
+@expect(messages.NostrPubkey)
+def get_pubkey(


this function should return just bytes of the public key.

perhaps it's a good idea to rebase on #4490

matejcik · 2025-01-13T10:15:26Z

python/src/trezorlib/cli/nostr.py

+
+    address_n = tools.parse_path(PATH_TEMPLATE.format(account))
+
+    res = nostr.get_pubkey(


just return nostr.get_pubkey, which should be changed to return bytes per the other comment

ibz self-assigned this Dec 10, 2024

ibz force-pushed the ibz/nostr branch from 7148b04 to 4f32cb3 Compare December 10, 2024 12:45

ibz linked an issue Dec 10, 2024 that may be closed by this pull request

Add app/feature to sign Nostr messages using m/44'/1237'/* keys. #4160

Open

ibz force-pushed the ibz/nostr branch 3 times, most recently from de9d4e4 to bd13fed Compare December 11, 2024 11:44

ibz changed the title ~~feat(core): add nostr event signing~~ Add Nostr Dec 11, 2024

ibz force-pushed the ibz/nostr branch 2 times, most recently from 9ef8c6a to feabb03 Compare December 11, 2024 14:40

prusnak reviewed Dec 11, 2024

View reviewed changes

prusnak reviewed Dec 12, 2024

View reviewed changes

ibz force-pushed the ibz/nostr branch 3 times, most recently from d66d0af to 8bc5409 Compare December 18, 2024 10:19

ibz marked this pull request as ready for review December 18, 2024 11:24

ibz requested a review from matejcik as a code owner December 18, 2024 11:24

ibz force-pushed the ibz/nostr branch from 7822ca3 to 4076b62 Compare December 19, 2024 08:48

ibz requested a review from martykan December 19, 2024 10:29

obrusvit reviewed Dec 19, 2024

View reviewed changes

common/protob/messages-nostr.proto Outdated Show resolved Hide resolved

common/protob/messages-nostr.proto Outdated Show resolved Hide resolved

core/src/apps/nostr/sign_event.py Show resolved Hide resolved

core/src/apps/nostr/sign_event.py Show resolved Hide resolved

ibz changed the title ~~Add Nostr~~ Introduce Nostr Dec 19, 2024

ibz added 7 commits January 7, 2025 12:26

feat(core): add nostr

294b8ef

fixup! feat(core): add nostr

9122ef9

fixup! feat(core): add nostr

e4f33f1

fixup! feat(core): add nostr

80293b5

fixup! feat(core): add nostr

7c392be

feat(core/ui): add basic confirmation for Nostr signing

b86d620

[no changelog]

fixup! fixup! feat(core): add nostr

a9ed827

ibz added 8 commits January 7, 2025 12:27

fixup! feat(core): add nostr

1566510

fixup! fixup! feat(core): add nostr

856d06c

fixup! feat(core): add nostr

631dfec

fixup! fixup! feat(core): add nostr

7326a76

fixup! feat(core): add nostr

2406187

chore(core/nostr): remove Nostr from production build

4dd31d4

[no changelog]

fixup! feat(core/ui): add basic confirmation for Nostr signing

14a8513

fixup! feat(core): add nostr

af4f669

ibz force-pushed the ibz/nostr branch from 126dc0b to af4f669 Compare January 7, 2025 11:27

matejcik reviewed Jan 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Nostr #4436

Introduce Nostr #4436

ibz commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024 •

edited

Loading

prusnak commented Dec 11, 2024 •

edited

Loading

prusnak Dec 12, 2024

prusnak Dec 12, 2024 •

edited

Loading

ibz Dec 19, 2024

prusnak Jan 13, 2025

ibz commented Dec 18, 2024

obrusvit left a comment

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025

matejcik Jan 13, 2025



		@auto_keychain(__name__)
		async def get_pubkey(msg: NostrGetPubkey, keychain: Keychain) -> NostrPubkey:



		@pytest.mark.setup_client(mnemonic=LEAD_MONKEY_MNEMONIC)
		def test_sign_event_lead_monkey(client: Client):


		address_n = tools.parse_path(PATH_TEMPLATE.format(account))

		res = nostr.get_pubkey(

Introduce Nostr #4436

Are you sure you want to change the base?

Introduce Nostr #4436

Conversation

ibz commented Dec 10, 2024 • edited Loading

Firmware

UI

Trezor Safe 5

Trezor Safe 3

Trezor Model T

trezorctl

get-pubkey

sign-event

github-actions bot commented Dec 10, 2024 • edited Loading

prusnak commented Dec 11, 2024 • edited Loading

Choose a reason for hiding this comment

prusnak Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ibz commented Dec 18, 2024

obrusvit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ibz commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024 •

edited

Loading

prusnak commented Dec 11, 2024 •

edited

Loading

prusnak Dec 12, 2024 •

edited

Loading