nostr-nsec-seedphrase
Version:
A comprehensive TypeScript library for Nostr key management with BIP39 seed phrases, supporting both ESM and CommonJS. Implements NIP-01, NIP-06, NIP-19, and NIP-26 with key generation, event signing, bech32 encoding/decoding, and secure cryptographic ope
628 lines (627 loc) • 23 kB
JavaScript
import { generateMnemonic, validateMnemonic, mnemonicToEntropy } from "bip39";
import { secp256k1, schnorr } from "@noble/curves/secp256k1.js";
import { bytesToHex, hexToBytes } from "@noble/hashes/utils.js";
import { sha256 } from "@noble/hashes/sha2.js";
import { hmac } from "@noble/hashes/hmac.js";
import { bech32 } from "bech32";
import { nip49 } from "nostr-crypto-utils";
import { logger } from "./utils/logger";
/**
* Generates a new BIP39 seed phrase
* @returns {string} A random 12-word BIP39 mnemonic seed phrase
* @example
* const seedPhrase = generateSeedPhrase();
* console.log(seedPhrase); // "witch collapse practice feed shame open despair creek road again ice least"
*/
export function generateSeedPhrase() {
return generateMnemonic();
}
/**
* Converts a BIP39 seed phrase to its entropy value
* @param {string} seedPhrase - The BIP39 seed phrase to convert
* @returns {Uint8Array} The entropy value
* @throws {Error} If the seed phrase is invalid
* @example
* const entropy = getEntropyFromSeedPhrase("witch collapse practice feed shame open despair creek road again ice least");
* console.log(entropy); // Uint8Array
*/
export function getEntropyFromSeedPhrase(seedPhrase) {
if (!validateMnemonic(seedPhrase)) {
throw new Error("Invalid seed phrase");
}
// bip39.mnemonicToEntropy returns a hex string, convert it to Uint8Array
const entropyHex = mnemonicToEntropy(seedPhrase);
return hexToBytes(entropyHex);
}
/**
* Validates a BIP39 seed phrase
* @param {string} seedPhrase - The seed phrase to validate
* @returns {boolean} True if the seed phrase is valid, false otherwise
* @example
* const isValid = validateSeedPhrase("witch collapse practice feed shame open despair creek road again ice least");
* console.log(isValid); // true
*/
export function validateSeedPhrase(seedPhrase) {
logger.log("Validating seed phrase");
logger.log("Input being validated");
const isValid = validateMnemonic(seedPhrase);
logger.log({ isValid }, "Validated seed phrase");
return Boolean(isValid);
}
/**
* Converts a BIP39 seed phrase to a Nostr key pair
* @param {string} seedPhrase - The BIP39 seed phrase to convert
* @returns {KeyPair} A key pair containing private and public keys in various formats
* @throws {Error} If the seed phrase is invalid or key generation fails
* @example
* const keyPair = seedPhraseToKeyPair("witch collapse practice feed shame open despair creek road again ice least");
* console.log(keyPair.privateKey); // hex private key
* console.log(keyPair.publicKey); // hex public key
* console.log(keyPair.nsec); // bech32 nsec private key
* console.log(keyPair.npub); // bech32 npub public key
*/
export function seedPhraseToKeyPair(seedPhrase) {
try {
const entropy = getEntropyFromSeedPhrase(seedPhrase);
// Hash the entropy to generate a proper private key
const privateKeyBytes = sha256(entropy);
entropy.fill(0); // zero sensitive material
const privateKeyHex = bytesToHex(privateKeyBytes);
privateKeyBytes.fill(0); // zero sensitive material
// Derive the public key
const publicKeyBytes = secp256k1.getPublicKey(hexToBytes(privateKeyHex), true); // Force compressed format
const publicKey = bytesToHex(publicKeyBytes);
// Generate the nsec and npub formats
const nsec = nip19.nsecEncode(privateKeyHex);
const npub = nip19.npubEncode(publicKey);
return {
privateKey: privateKeyHex,
publicKey,
nsec,
npub,
seedPhrase,
};
}
catch (error) {
logger.error("Failed to create key pair from seed phrase:", error?.toString());
throw error;
}
}
/**
* Generates a new key pair with a random seed phrase
* @returns {KeyPair} A new key pair containing private and public keys in various formats
* @example
* const keyPair = generateKeyPairWithSeed();
* console.log(keyPair.seedPhrase); // random seed phrase
* console.log(keyPair.privateKey); // hex private key
* console.log(keyPair.publicKey); // hex public key
*/
export function generateKeyPairWithSeed() {
const seedPhrase = generateMnemonic();
return seedPhraseToKeyPair(seedPhrase);
}
/**
* Creates a key pair from a hex private key
* @param {string} privateKeyHex - The hex-encoded private key
* @returns {KeyPair} A key pair containing private and public keys in various formats
* @throws {Error} If the private key is invalid
* @example
* const keyPair = fromHex("1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef");
* console.log(keyPair.publicKey); // corresponding public key
* console.log(keyPair.nsec); // bech32 nsec private key
* console.log(keyPair.npub); // bech32 npub public key
*/
export function fromHex(privateKeyHex) {
try {
// Validate the private key
const privateKeyBytes = hexToBytes(privateKeyHex);
if (!secp256k1.utils.isValidSecretKey(privateKeyBytes)) {
privateKeyBytes.fill(0); // zero sensitive material
throw new Error("Invalid private key");
}
// Derive the public key
const publicKeyBytes = secp256k1.getPublicKey(privateKeyBytes, true); // Force compressed format
privateKeyBytes.fill(0); // zero sensitive material
const publicKey = bytesToHex(publicKeyBytes);
// Generate the nsec and npub formats
const nsec = nip19.nsecEncode(privateKeyHex);
const npub = nip19.npubEncode(publicKey);
return {
privateKey: privateKeyHex,
publicKey,
nsec,
npub,
seedPhrase: "", // No seed phrase for hex-imported keys
};
}
catch (error) {
logger.error("Failed to create key pair from hex:", error?.toString());
throw error;
}
}
/**
* Derives a public key from a private key
* @param {string} privateKey - The hex-encoded private key
* @returns {string} The hex-encoded public key
* @example
* const pubkey = getPublicKey("1234567890abcdef...");
* console.log(pubkey); // hex public key
*/
export function getPublicKey(privateKey) {
try {
const privateKeyBytes = hexToBytes(privateKey);
const publicKeyBytes = secp256k1.getPublicKey(privateKeyBytes, true); // Force compressed format
privateKeyBytes.fill(0); // zero sensitive material
return bytesToHex(publicKeyBytes);
}
catch (error) {
logger.error("Failed to get public key:", error?.toString());
throw error;
}
}
/**
* NIP-19 encoding and decoding functions
* @namespace
*/
export const nip19 = {
/**
* Encodes a public key into npub format
* @param {string} pubkey - The hex-encoded public key
* @returns {string} The bech32-encoded npub string
*/
npubEncode(pubkey) {
const data = hexToBytes(pubkey);
const words = bech32.toWords(Uint8Array.from(data));
return bech32.encode("npub", words, 1000);
},
/**
* Decodes an npub string to hex format
* @param {string} npub - The bech32-encoded npub string
* @returns {string} The hex-encoded public key
*/
npubDecode(npub) {
const { prefix, words } = bech32.decode(npub, 1000);
if (prefix !== "npub")
throw new Error("Invalid npub: wrong prefix");
const data = bech32.fromWords(words);
return bytesToHex(data instanceof Uint8Array ? data : Uint8Array.from(data));
},
/**
* Encodes a private key into nsec format
* @param {string} privkey - The hex-encoded private key
* @returns {string} The bech32-encoded nsec string
*/
nsecEncode(privkey) {
const data = hexToBytes(privkey);
const words = bech32.toWords(Uint8Array.from(data));
return bech32.encode("nsec", words, 1000);
},
/**
* Decodes an nsec string to hex format
* @param {string} nsec - The bech32-encoded nsec string
* @returns {string} The hex-encoded private key
*/
nsecDecode(nsec) {
const { prefix, words } = bech32.decode(nsec, 1000);
if (prefix !== "nsec")
throw new Error("Invalid nsec: wrong prefix");
const data = bech32.fromWords(words);
return bytesToHex(data instanceof Uint8Array ? data : Uint8Array.from(data));
},
/**
* Encodes an event ID into note format
* @param {string} eventId - The hex-encoded event ID
* @returns {string} The bech32-encoded note string
*/
noteEncode(eventId) {
const data = hexToBytes(eventId);
const words = bech32.toWords(Uint8Array.from(data));
return bech32.encode("note", words, 1000);
},
/**
* Decodes a note string to hex format
* @param {string} note - The bech32-encoded note string
* @returns {string} The hex-encoded event ID
*/
noteDecode(note) {
const { prefix, words } = bech32.decode(note, 1000);
if (prefix !== "note")
throw new Error("Invalid note: wrong prefix");
const data = bech32.fromWords(words);
return bytesToHex(data instanceof Uint8Array ? data : Uint8Array.from(data));
},
/**
* Decodes any bech32-encoded Nostr entity
* @param {string} bech32str - The bech32-encoded string
* @returns {{ type: string; data: Uint8Array }} Object containing the decoded type and data
* @property {string} type - The type of the decoded entity (npub, nsec, or note)
* @property {Uint8Array} data - The raw decoded data
*/
decode(bech32str) {
const { prefix, words } = bech32.decode(bech32str, 1000);
const data = bech32.fromWords(words);
return {
type: prefix,
data: data instanceof Uint8Array ? data : Uint8Array.from(data),
};
},
};
/**
* Calculates the event hash/ID according to the Nostr protocol
* @param {UnsignedEvent} event - The event to hash
* @returns {string} The hex-encoded event hash
*/
function getEventHash(event) {
const serialized = JSON.stringify([
0,
event.pubkey,
event.created_at,
event.kind,
event.tags,
event.content,
]);
return bytesToHex(sha256(new TextEncoder().encode(serialized)));
}
/**
* Signs a Nostr event
* @param {UnsignedEvent} event - The event to sign
* @param {string} privateKey - The hex-encoded private key to sign with
* @returns {Promise<string>} The hex-encoded signature
* @throws {Error} If signing fails
* @example
* const signature = await signEvent({
* pubkey: "...",
* created_at: Math.floor(Date.now() / 1000),
* kind: 1,
* tags: [],
* content: "Hello Nostr!"
* }, privateKey);
*/
export async function signEvent(event, privateKey) {
try {
const eventHash = getEventHash(event);
const privateKeyBytes = hexToBytes(privateKey);
const signature = schnorr.sign(hexToBytes(eventHash), privateKeyBytes);
privateKeyBytes.fill(0); // zero sensitive material
logger.log("Event signed successfully");
return bytesToHex(signature);
}
catch (error) {
logger.error("Failed to sign event:", error?.toString());
throw error;
}
}
/**
* Verifies a Nostr event signature
* @param {NostrEvent} event - The event to verify
* @returns {Promise<boolean>} True if the signature is valid, false otherwise
* @example
* const isValid = await verifyEvent(event);
* console.log(isValid); // true or false
*/
export async function verifyEvent(event) {
try {
if (!event.id || !event.pubkey || !event.sig) {
logger.log("Invalid event: missing required fields");
return false;
}
const hash = getEventHash(event);
if (hash !== event.id) {
logger.log("Event hash mismatch");
return false;
}
logger.log("Verifying event signature");
return schnorr.verify(hexToBytes(event.sig), hexToBytes(hash), hexToBytes(event.pubkey));
}
catch (error) {
logger.error("Failed to verify event:", error?.toString());
throw error;
}
}
/**
* Configures secp256k1 with HMAC for WebSocket utilities
* This is required for some WebSocket implementations
* @example
* configureHMAC();
*/
export function configureHMAC() {
const hmacFunction = (key, ...messages) => {
const h = hmac.create(sha256, key);
messages.forEach((msg) => h.update(msg));
return h.digest();
};
const hmacSyncFunction = (key, ...messages) => {
const h = hmac.create(sha256, key);
messages.forEach((msg) => h.update(msg));
return h.digest();
};
// Safety check: only patch if utils exists and hmacSha256Sync is a known property
if ("utils" in secp256k1 &&
typeof secp256k1.utils?.hmacSha256Sync !== "undefined") {
secp256k1.utils.hmacSha256 = hmacFunction;
secp256k1.utils.hmacSha256Sync = hmacSyncFunction;
}
else {
logger.log("secp256k1.utils.hmacSha256Sync not found; HMAC configuration skipped (library may handle HMAC internally)");
}
logger.log("Configured HMAC for secp256k1");
}
/**
* Creates a new signed Nostr event
* @param {string} content - The event content
* @param {number} kind - The event kind (1 for text note, etc.)
* @param {string} privateKey - The hex-encoded private key to sign with
* @param {string[][]} [tags=[]] - Optional event tags
* @returns {Promise<NostrEvent>} The signed event
* @throws {Error} If event creation or signing fails
* @example
* const event = await createEvent(
* "Hello Nostr!",
* 1,
* privateKey,
* [["t", "nostr"]]
* );
* console.log(event); // complete signed event
*/
export async function createEvent(content, kind, privateKey, tags = []) {
const publicKey = getPublicKey(privateKey);
const event = {
pubkey: publicKey,
created_at: Math.floor(Date.now() / 1000),
kind,
tags,
content,
};
const id = getEventHash(event);
const sig = await signEvent(event, privateKey);
logger.log("Created new Nostr event");
return {
...event,
id,
sig,
};
}
/**
* Converts a BIP39 seed phrase to a private key
* @param {string} seedPhrase - The BIP39 seed phrase to convert
* @returns {string} The hex-encoded private key
* @throws {Error} If the seed phrase is invalid
* @example
* const privateKey = seedPhraseToPrivateKey("witch collapse practice feed shame open despair creek road again ice least");
* console.log(privateKey); // hex private key
*/
export function seedPhraseToPrivateKey(seedPhrase) {
return seedPhraseToKeyPair(seedPhrase).privateKey;
}
/**
* Converts a private key to bech32 nsec format
* @param {string} privateKey - The hex-encoded private key
* @returns {string} The bech32-encoded nsec private key
* @throws {Error} If the private key is invalid
* @example
* const nsec = privateKeyToNsec("1234567890abcdef...");
* console.log(nsec); // "nsec1..."
*/
export function privateKeyToNsec(privateKey) {
try {
return nip19.nsecEncode(privateKey);
}
catch (error) {
logger.error("Failed to encode nsec:", error?.toString());
throw error;
}
}
/**
* Converts a private key to bech32 npub format
* @param {string} privateKey - The hex-encoded private key
* @returns {string} The bech32-encoded npub public key
* @throws {Error} If the private key is invalid
* @example
* const npub = privateKeyToNpub("1234567890abcdef...");
* console.log(npub); // "npub1..."
*/
export function privateKeyToNpub(privateKey) {
try {
const privateKeyBytes = hexToBytes(privateKey);
const publicKey = secp256k1.getPublicKey(privateKeyBytes, true);
privateKeyBytes.fill(0); // zero sensitive material
return nip19.npubEncode(bytesToHex(publicKey));
}
catch (error) {
logger.error("Failed to encode npub:", error?.toString());
throw error;
}
}
/**
* Converts a bech32 nsec private key to hex format
* @param {string} nsec - The bech32-encoded nsec private key
* @returns {string} The hex-encoded private key
* @throws {Error} If the nsec key is invalid
* @example
* const hex = nsecToHex("nsec1...");
* console.log(hex); // "1234567890abcdef..."
*/
export function nsecToHex(nsec) {
try {
const hexPrivateKey = nip19.nsecDecode(nsec);
logger.log("Converted nsec to hex");
return hexPrivateKey;
}
catch (error) {
logger.error("Failed to decode nsec:", error?.toString());
throw error;
}
}
/**
* Converts a bech32 npub public key to hex format
* @param {string} npub - The bech32-encoded npub public key
* @returns {string} The hex-encoded public key
* @throws {Error} If the npub key is invalid
* @example
* const hex = npubToHex("npub1...");
* console.log(hex); // "1234567890abcdef..."
*/
export function npubToHex(npub) {
try {
const { type, data } = nip19.decode(npub);
if (type !== "npub") {
throw new Error("Invalid npub format");
}
logger.log("Converted npub to hex");
return bytesToHex(data);
}
catch (error) {
logger.error("Failed to decode npub:", error?.toString());
throw error;
}
}
/**
* Converts a hex public key to bech32 npub format
* @param {string} publicKeyHex - The hex-encoded public key
* @returns {string} The bech32-encoded npub public key
* @throws {Error} If the public key is invalid
* @example
* const npub = hexToNpub("1234567890abcdef...");
* console.log(npub); // "npub1..."
*/
export function hexToNpub(publicKeyHex) {
try {
logger.log("Converting hex to npub");
return nip19.npubEncode(publicKeyHex);
}
catch (error) {
logger.error("Failed to encode npub:", error?.toString());
throw error;
}
}
/**
* Converts a hex private key to bech32 nsec format
* @param {string} privateKeyHex - The hex-encoded private key
* @returns {string} The bech32-encoded nsec private key
* @throws {Error} If the private key is invalid
* @example
* const nsec = hexToNsec("1234567890abcdef...");
* console.log(nsec); // "nsec1..."
*/
export function hexToNsec(privateKeyHex) {
try {
logger.log("Converting hex to nsec");
return nip19.nsecEncode(privateKeyHex);
}
catch (error) {
logger.error("Failed to encode nsec:", error?.toString());
throw error;
}
}
/**
* Signs a message with a private key
* @param {string} message - The message to sign
* @param {string} privateKey - The hex-encoded private key to sign with
* @returns {Promise<string>} The hex-encoded signature
* @throws {Error} If signing fails
* @example
* const signature = await signMessage("Hello Nostr!", privateKey);
* console.log(signature); // hex-encoded signature
*/
export async function signMessage(message, privateKey) {
try {
const messageBytes = new TextEncoder().encode(message);
const messageHash = sha256(messageBytes);
const messageHashHex = bytesToHex(messageHash);
const privateKeyBytes = hexToBytes(privateKey);
const signature = schnorr.sign(hexToBytes(messageHashHex), privateKeyBytes);
privateKeyBytes.fill(0); // zero sensitive material
logger.log("Message signed successfully");
return bytesToHex(signature);
}
catch (error) {
logger.error("Failed to sign message:", error?.toString());
throw error;
}
}
/**
* Verifies a message signature
* @param {string} message - The original message
* @param {string} signature - The hex-encoded signature to verify
* @param {string} publicKey - The hex-encoded public key to verify against
* @returns {Promise<boolean>} True if the signature is valid, false otherwise
* @example
* const isValid = await verifySignature("Hello Nostr!", signature, publicKey);
* console.log(isValid); // true or false
*/
export async function verifySignature(message, signature, publicKey) {
try {
const messageBytes = new TextEncoder().encode(message);
const messageHash = sha256(messageBytes);
const messageHashHex = bytesToHex(messageHash);
logger.log("Verifying message signature");
return schnorr.verify(hexToBytes(signature), hexToBytes(messageHashHex), hexToBytes(publicKey));
}
catch (error) {
logger.error("Failed to verify signature:", error?.toString());
throw error;
}
}
/**
* Converts a bech32 nsec private key to hex format
* @param {string} nsec - The bech32-encoded nsec private key
* @returns {string} The hex-encoded private key
* @throws {Error} If the nsec key is invalid
* @example
* const hex = nsecToPrivateKey("nsec1...");
* console.log(hex); // "1234567890abcdef..."
*/
export function nsecToPrivateKey(nsec) {
try {
return nip19.nsecDecode(nsec);
}
catch (error) {
logger.error("Failed to decode nsec:", error?.toString());
throw error;
}
}
/**
* Encrypts a hex private key into an ncryptsec bech32 string (NIP-49)
* @param {string} privateKeyHex - The hex-encoded private key (64 hex chars / 32 bytes)
* @param {string} password - The password to encrypt with
* @param {number} [logn=16] - Scrypt log2(N) parameter (higher = slower but more secure)
* @returns {string} The bech32-encoded ncryptsec string
* @throws {Error} If encryption fails
* @example
* const ncryptsec = toNcryptsec("1234567890abcdef...", "my-strong-password");
* console.log(ncryptsec); // "ncryptsec1..."
*/
export function toNcryptsec(privateKeyHex, password, logn = 16) {
try {
const secretBytes = hexToBytes(privateKeyHex);
const result = nip49.encrypt(secretBytes, password, logn);
secretBytes.fill(0); // zero sensitive material
return result;
}
catch (error) {
logger.error("Failed to encrypt private key to ncryptsec:", error?.toString());
throw error;
}
}
/**
* Decrypts an ncryptsec bech32 string back to a hex private key (NIP-49)
* @param {string} ncryptsec - The bech32-encoded ncryptsec string
* @param {string} password - The password used for encryption
* @returns {string} The hex-encoded private key
* @throws {Error} If decryption fails (wrong password, invalid format, etc.)
* @example
* const privateKeyHex = fromNcryptsec("ncryptsec1...", "my-strong-password");
* console.log(privateKeyHex); // "1234567890abcdef..."
*/
export function fromNcryptsec(ncryptsec, password) {
try {
const secretBytes = nip49.decrypt(ncryptsec, password);
const hex = bytesToHex(secretBytes);
secretBytes.fill(0); // zero sensitive material
return hex;
}
catch (error) {
logger.error("Failed to decrypt ncryptsec:", error?.toString());
throw error;
}
}