add secret key and pubkey NIP-19 helpers

Author: hzrd149

.changeset/tame-pandas-mix.md

@@ -0,0 +1,5 @@
+---
+"applesauce-core": minor
+---
+
+Add `normalizeToPubkey` and `normalizeToSecretKey` NIP-19 helpers

packages/core/package.json

@@ -68,6 +68,7 @@
     }
   },
   "dependencies": {
+    "@noble/hashes": "^1.7.1",
     "@scure/base": "^1.2.4",
     "debug": "^4.4.0",
     "fast-deep-equal": "^3.1.3",

packages/core/src/helpers/__tests__/nip-19.test.ts

@@ -0,0 +1,63 @@
+import { describe, expect, it } from "vitest";
+import { bytesToHex } from "@noble/hashes/utils";
+import { normalizeToPubkey, normalizeToSecretKey } from "../nip-19.js";
+
+describe("normalizeToPubkey", () => {
+  it("should get pubkey from npub", () => {
+    expect(normalizeToPubkey("npub1ye5ptcxfyyxl5vjvdjar2ua3f0hynkjzpx552mu5snj3qmx5pzjscpknpr")).toEqual(
+      "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5",
+    );
+  });
+
+  it("should get pubkey from nprofile", () => {
+    expect(
+      normalizeToPubkey(
+        "nprofile1qyw8wumn8ghj7umpw3jkcmrfw3jju6r6wfjrzdpe9e3k7mf0qyf8wumn8ghj7mn0wd68yat99e3k7mf0qqszv6q4uryjzr06xfxxew34wwc5hmjfmfpqn229d72gfegsdn2q3fg5g7lja",
+      ),
+    ).toEqual("266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5");
+  });
+
+  it("should return hex pubkey", () => {
+    expect(normalizeToPubkey("266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5")).toEqual(
+      "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5",
+    );
+  });
+
+  it("should throw on invalid hex pubkey", () => {
+    expect(() => {
+      normalizeToPubkey("5028372");
+    }).toThrow();
+  });
+
+  it("should throw on invalid string", () => {
+    expect(() => {
+      normalizeToPubkey("testing");
+    }).toThrow();
+  });
+});
+
+describe("normalizeToSecretKey", () => {
+  it("should get secret key from nsec", () => {
+    expect(bytesToHex(normalizeToSecretKey("nsec1xe7znq745x5n68566l32ru72aajz3pk2cys9lnf3tuexvkw0dldsj8v2lm"))).toEqual(
+      "367c2983d5a1a93d1e9ad7e2a1f3caef642886cac1205fcd315f326659cf6fdb",
+    );
+  });
+
+  it("should get secret key from raw hex", () => {
+    expect(
+      bytesToHex(normalizeToSecretKey("367c2983d5a1a93d1e9ad7e2a1f3caef642886cac1205fcd315f326659cf6fdb")),
+    ).toEqual("367c2983d5a1a93d1e9ad7e2a1f3caef642886cac1205fcd315f326659cf6fdb");
+  });
+
+  it("should throw on invalid hex key", () => {
+    expect(() => {
+      normalizeToSecretKey("209573290");
+    }).toThrow();
+  });
+
+  it("should throw on npub", () => {
+    expect(() => {
+      normalizeToSecretKey("npub1ye5ptcxfyyxl5vjvdjar2ua3f0hynkjzpx552mu5snj3qmx5pzjscpknpr");
+    }).toThrow();
+  });
+});

packages/core/src/helpers/hidden-tags.ts

@@ -21,7 +21,7 @@ export const HiddenTagsSymbol = Symbol.for("hidden-tags");
 /** Various event kinds that can have encrypted tags in their content and which encryption method they use */
 export const EventEncryptionMethod: Record<number, "nip04" | "nip44"> = {
   // NIP-60 wallet
-  37375: "nip44",
+  17375: "nip44",
 
   // NIP-51 lists
   [kinds.BookmarkList]: "nip04",

packages/core/src/helpers/nip-19.ts

@@ -0,0 +1,26 @@
+import { nip19 } from "nostr-tools";
+import { hexToBytes } from "@noble/hashes/utils";
+
+import { isHexKey } from "./string.js";
+import { getPubkeyFromDecodeResult } from "./pointers.js";
+
+/** Gets the hex pubkey from any nip-19 encoded string */
+export function normalizeToPubkey(str: string): string {
+  if (isHexKey(str)) return str;
+  else {
+    const decode = nip19.decode(str);
+    const pubkey = getPubkeyFromDecodeResult(decode);
+    if (!pubkey) throw new Error(`Cant find pubkey in ${decode.type}`);
+    return pubkey;
+  }
+}
+
+/** Converts hex to nsec strings into Uint8 secret keys */
+export function normalizeToSecretKey(str: string): Uint8Array {
+  if (isHexKey(str)) return hexToBytes(str);
+  else {
+    const decode = nip19.decode(str);
+    if (decode.type !== "nsec") throw new Error(`Cant get secret key from ${decode.type}`);
+    return decode.data;
+  }
+}