feat: improved NIP-19 implementation

- Updated nostr-crypto-utils to version 0.4.5
- Improved NIP-19 implementation using updated exports
- Enhanced error messages and logging
- Streamlined type imports
- Added CHANGELOG.md
- Version bump to 0.6.2

Author: vveerrgg

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.6.2] - 2024-12-29
+
+### Changed
+- Updated nostr-crypto-utils to version 0.4.5
+- Improved NIP-19 implementation using updated nostr-crypto-utils exports
+- Enhanced error messages with more detailed logging
+- Streamlined type imports from nostr-crypto-utils
+
+### Fixed
+- Removed duplicate Nip19Data type definition
+- Improved error handling in NIP-19 functions
+- Better error messages in NIP-19 encoding/decoding functions

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "nostr-nsec-seedphrase",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "A comprehensive TypeScript library for Nostr key management with BIP39 seed phrases, supporting NIP-01, NIP-06, NIP-19, and NIP-26. Features include key generation, event signing, bech32 encoding/decoding, and secure cryptographic operations.",
   "type": "module",
   "main": "./dist/index.js",
@@ -60,7 +60,7 @@
     "@scure/base": "^1.2.1",
     "bech32": "^2.0.0",
     "bip39": "^3.1.0",
-    "nostr-crypto-utils": "^0.4.2",
+    "nostr-crypto-utils": "^0.4.5",
     "pino": "^8.17.2"
   },
   "devDependencies": {

package.json

@@ -7,29 +7,9 @@
  * @see https://github.com/nostr-protocol/nips/blob/master/19.md
  */
 
-import { bech32 } from '@scure/base';
-import { bytesToHex, hexToBytes } from '@noble/hashes/utils';
-import { sha256 } from '@noble/hashes/sha256';
 import { logger } from '../utils/logger.js';
-import type { Bech32Result } from '../types/index.js';
-
-/**
- * Valid bech32 prefix types for Nostr entities
- * @typedef {('npub1' | 'nsec1' | 'note1')} Bech32Prefix
- */
-type Bech32Prefix = 'npub1' | 'nsec1' | 'note1';
-
-/**
- * Ensures the input string has a valid bech32 format by adding '1' if missing
- * @param {string} str - Input string to format
- * @returns {string} Properly formatted bech32 string
- * @example
- * ensureBech32Format('npub') // returns 'npub1'
- * ensureBech32Format('npub1abc') // returns 'npub1abc'
- */
-function ensureBech32Format(str: string): `${string}1${string}` {
-  return str.includes('1') ? str as `${string}1${string}` : `${str}1`;
-}
+import { npubEncode, nsecEncode, noteEncode, decode as nip19Decode } from 'nostr-crypto-utils';
+import type { Nip19Data } from 'nostr-crypto-utils';
 
 /**
  * Encodes a public key into npub format
@@ -38,17 +18,14 @@ function ensureBech32Format(str: string): `${string}1${string}` {
  * @throws {Error} If encoding fails
  * @example
  * const npub = hexToNpub('3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d');
- * // returns 'npub1...'
+ * returns 'npub1...'
  */
 export function hexToNpub(hex: string): string {
   try {
-    const bytes = hexToBytes(hex);
-    const words = bech32.toWords(bytes);
-    const encoded = bech32.encode('npub1' as Bech32Prefix, words);
-    return encoded;
+    return npubEncode(hex);
   } catch (error) {
-    logger.error('Failed to encode npub:', error);
-    throw new Error('Failed to encode npub');
+    logger.error({ error, hex }, 'Failed to encode public key to npub');
+    throw error;
   }
 }
 
@@ -60,17 +37,14 @@ export function hexToNpub(hex: string): string {
  * @security This function handles sensitive private key data
  * @example
  * const nsec = hexToNsec('3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d');
- * // returns 'nsec1...'
+ * returns 'nsec1...'
  */
 export function hexToNsec(hex: string): string {
   try {
-    const bytes = hexToBytes(hex);
-    const words = bech32.toWords(bytes);
-    const encoded = bech32.encode('nsec1' as Bech32Prefix, words);
-    return encoded;
+    return nsecEncode(hex);
   } catch (error) {
-    logger.error('Failed to encode nsec:', error);
-    throw new Error('Failed to encode nsec');
+    logger.error({ error, hex }, 'Failed to encode private key to nsec');
+    throw error;
   }
 }
 
@@ -81,38 +55,32 @@ export function hexToNsec(hex: string): string {
  * @throws {Error} If encoding fails
  * @example
  * const note = hexToNote('3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d');
- * // returns 'note1...'
+ * returns 'note1...'
  */
 export function hexToNote(hex: string): string {
   try {
-    const bytes = hexToBytes(hex);
-    const words = bech32.toWords(bytes);
-    const encoded = bech32.encode('note1' as Bech32Prefix, words);
-    return encoded;
+    return noteEncode(hex);
   } catch (error) {
-    logger.error('Failed to encode note:', error);
-    throw new Error('Failed to encode note');
+    logger.error({ error, hex }, 'Failed to encode event ID to note');
+    throw error;
   }
 }
 
 /**
  * Decodes a bech32-encoded Nostr entity
  * @param {string} str - The bech32-encoded string (npub1, nsec1, or note1)
- * @returns {Bech32Result} Object containing the decoded type and data
+ * @returns {Nip19Data} Object containing the decoded type and data
  * @throws {Error} If decoding fails
  * @example
  * const result = decode('npub1...');
- * // returns { type: 'npub', data: Uint8Array }
+ * returns { type: 'npub', data: '...' }
  */
-export function decode(str: string): Bech32Result {
+export function decode(str: string): Nip19Data {
   try {
-    const formattedStr = ensureBech32Format(str);
-    const { prefix, words } = bech32.decode(formattedStr);
-    const data = new Uint8Array(bech32.fromWords(words));
-    return { type: prefix.replace(/1$/, ''), data };
+    return nip19Decode(str);
   } catch (error) {
-    logger.error('Failed to decode bech32:', error);
-    throw new Error('Failed to decode bech32');
+    logger.error({ error, str }, 'Failed to decode bech32-encoded string');
+    throw error;
   }
 }
 
@@ -124,18 +92,18 @@ export function decode(str: string): Bech32Result {
  * @security This function handles sensitive private key data
  * @example
  * const hex = nsecToHex('nsec1...');
- * // returns '3bf0c63f...'
+ * returns '3bf0c63f...'
  */
 export function nsecToHex(nsec: string): string {
   try {
-    const { type, data } = decode(nsec);
-    if (type !== 'nsec') {
-      throw new Error('Invalid nsec format');
+    const decoded = decode(nsec);
+    if (decoded.type !== 'nsec') {
+      throw new Error(`Invalid nsec format: ${nsec}`);
     }
-    return bytesToHex(data);
+    return decoded.data;
   } catch (error) {
-    logger.error('Failed to convert nsec to hex:', error);
-    throw new Error('Failed to convert nsec to hex');
+    logger.error({ error, nsec }, 'Failed to convert nsec to hex');
+    throw error;
   }
 }
 
@@ -146,17 +114,17 @@ export function nsecToHex(nsec: string): string {
  * @throws {Error} If conversion fails or input is invalid
  * @example
  * const hex = npubToHex('npub1...');
- * // returns '3bf0c63f...'
+ * returns '3bf0c63f...'
  */
 export function npubToHex(npub: string): string {
   try {
-    const { type, data } = decode(npub);
-    if (type !== 'npub') {
-      throw new Error('Invalid npub format');
+    const decoded = decode(npub);
+    if (decoded.type !== 'npub') {
+      throw new Error(`Invalid npub format: ${npub}`);
     }
-    return bytesToHex(data);
+    return decoded.data;
   } catch (error) {
-    logger.error('Failed to convert npub to hex:', error);
-    throw new Error('Failed to convert npub to hex');
+    logger.error({ error, npub }, 'Failed to convert npub to hex');
+    throw error;
   }
 }

src/nips/nip-19.ts

@@ -1,2 +1,19 @@
-export * from './keys.js';
-export type { Tag, UnsignedEvent, NostrEvent } from './events.js';
+/**
+ * @module types
+ * @description Type definitions for the nostr-nsec-seedphrase library
+ */
+
+// Export events types
+export type { 
+  NostrEvent,
+  ValidationResult 
+} from './events.js';
+
+// Export key types
+export type {
+  KeyPair,
+  PublicKeyDetails
+} from './keys.js';
+
+// Import and re-export Nip19Data type from nostr-crypto-utils
+export type { Nip19Data } from 'nostr-crypto-utils';