Merge remote-tracking branch 'origin/main'

Author: vveerrgg

.eslintrc.json

@@ -11,14 +11,16 @@
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": "latest",
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": "./tsconfig.eslint.json"
   },
   "plugins": [
     "@typescript-eslint"
   ],
   "rules": {
-    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
-  }
+  },
+  "ignorePatterns": ["dist/", "node_modules/"]
 }

README.md

@@ -1,17 +1,17 @@
-# Nostr Nsec Seedphrase Library
+# nostr-nsec-seedphrase
 
-[![npm version](https://badge.fury.io/js/nostr-nsec-seedphrase.svg)](https://badge.fury.io/js/nostr-nsec-seedphrase)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-4.9.5-blue.svg)](https://www.typescriptlang.org/)
-[![Node.js CI](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase-library/workflows/Node.js%20CI/badge.svg)](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase-library/actions)
+<div align="center">
 
-A comprehensive TypeScript library designed to make Nostr keys more human-readable and easier to manage. By converting `nsec` keys to mnemonic seed phrases, this library simplifies the process of storing and re-entering keys into Nostr applications.
+[![npm version](https://img.shields.io/npm/v/nostr-nsec-seedphrase.svg)](https://www.npmjs.com/package/nostr-nsec-seedphrase)
+[![npm downloads](https://img.shields.io/npm/dm/nostr-nsec-seedphrase.svg)](https://www.npmjs.com/package/nostr-nsec-seedphrase)
+[![License](https://img.shields.io/npm/l/nostr-nsec-seedphrase.svg)](https://github.com/vergelevans/nostr-nsec-seedphrase/blob/main/LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+[![Test Status](https://img.shields.io/github/actions/workflow/status/vergelevans/nostr-nsec-seedphrase/test.yml?branch=main&label=tests)](https://github.com/vergelevans/nostr-nsec-seedphrase/actions)
+[![Code Style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
 
-⚠️ **Important Security Notice**
+</div>
 
-This library handles cryptographic keys and seed phrases that are critical for securing your Nostr identity and data. Just like Bitcoin, any seed phrase or private key (`nsec`) generated by this library must be stored with the utmost security and care.
-
-Developers using this library must inform their users about the critical nature of managing seed phrases, `nsec`, and hex keys. It is the user's responsibility to securely store and manage these keys. The library and its authors disclaim any responsibility or liability for lost keys, seed phrases, or data resulting from mismanagement.
+A comprehensive TypeScript library for managing Nostr keys with seed phrases, including event signing, verification, and WebSocket utilities.
 
 ## Installation
 
@@ -35,16 +35,18 @@ Full API documentation is available at [https://humanjavaenterprises.github.io/n
 
 ## Features
 
-- Generate secure BIP39 mnemonics for Nostr key pairs
-- Create nsec private keys from hex format
-- Convert between nsec/npub and hex representations
-- TypeScript support with comprehensive type definitions
-- Secure key management utilities
-- Extensive testing and documentation
+- 🔑 Generate and manage seed phrases for Nostr keys
+- 🔄 Convert between different key formats (hex, nsec, npub)
+- ✍️ Sign and verify messages
+- 📝 Create and verify Nostr events
+- 🌐 WebSocket utilities for Nostr applications
+- 📦 TypeScript support with full type definitions
+- ✅ Comprehensive test coverage
+- 🔒 Secure key management practices
 
 ## Usage
 
-### Basic Key Generation
+### Key Generation and Management
 
 ```typescript
 import { 
@@ -57,181 +59,91 @@ import {
   seedPhraseToKeyPair
 } from 'nostr-nsec-seedphrase';
 
-// Generate new keys with seed phrase
+// Generate a new key pair with seed phrase
 const keyPair = generateKeyPairWithSeed();
 console.log(keyPair);
 // {
-//   seedPhrase: "your twelve word seed phrase here",
-//   nsec: "nsec1...",
-//   npub: "npub1...",
-//   privateKey: "hex...",
-//   publicKey: "hex..."
+//   privateKey: '...',
+//   publicKey: '...',
+//   nsec: '...',
+//   npub: '...',
+//   seedPhrase: '...'
 // }
 
-// Validate the seed phrase
-const isValid = validateSeedPhrase(keyPair.seedPhrase);
-console.log(isValid); // true
-```
-
-### Converting Between Formats
-
-```typescript
-// Convert hex to nsec/npub
-const nsec = hexToNsec('your-hex-private-key');
-const npub = hexToNpub('your-hex-public-key');
-
-// Convert nsec/npub to hex
-const privateKeyHex = nsecToHex('nsec1...');
-const publicKeyHex = npubToHex('npub1...');
-
-// Convert seed phrase to key pair
-const keyPair = seedPhraseToKeyPair('your twelve word seed phrase here');
+// Convert existing seed phrase to key pair
+const existingKeyPair = seedPhraseToKeyPair('your twelve word seed phrase here');
 ```
 
-### Converting Nsec to Seedphrase
+### Message Signing and Verification
 
 ```typescript
-const seedPhrase = await NostrSeedPhrase.nsecToSeed('nsec1...');
-console.log(seedPhrase); // "your twelve word mnemonic phrase here"
-```
+import { signMessage, verifySignature } from 'nostr-nsec-seedphrase';
 
-### Converting Seedphrase to Nsec
+// Sign a message
+const signature = await signMessage('Hello Nostr!', keyPair.privateKey);
 
-```typescript
-const nsec = await NostrSeedPhrase.seedToNsec('your twelve word mnemonic phrase here');
-console.log(nsec); // "nsec1..."
+// Verify a signature
+const isValid = await verifySignature('Hello Nostr!', signature, keyPair.publicKey);
 ```
 
-### Converting Hex to Nsec
+### Event Creation and Verification
 
 ```typescript
-const nsec = await NostrSeedPhrase.hexToNsec('your-hex-private-key');
-console.log(nsec); // "nsec1..."
+import { createEvent, verifyEvent } from 'nostr-nsec-seedphrase';
+
+// Create a new event
+const event = await createEvent(
+  'Hello Nostr!',  // content
+  1,               // kind (1 = text note)
+  keyPair.privateKey,
+  []               // tags (optional)
+);
+
+// Verify an event
+const isValidEvent = await verifyEvent(event);
 ```
 
-### Converting Nsec to Hex
+## Recent Updates
 
-```typescript
-const hex = await NostrSeedPhrase.nsecToHex('nsec1...');
-console.log(hex); // "hex..."
-```
-
-### Converting Npub to Hex
-
-```typescript
-const hex = await NostrSeedPhrase.npubToHex('npub1...');
-console.log(hex); // "hex..."
-```
-
-### Converting Hex to Npub
-
-```typescript
-const npub = await NostrSeedPhrase.hexToNpub('hex...');
-console.log(npub); // "npub1..."
-```
+### v0.2.0
+- 🔧 Fixed HMAC configuration for secp256k1
+- ✅ Added comprehensive test coverage
+- 🎯 Improved TypeScript types
+- 📚 Enhanced documentation
 
 ## API Reference
 
-### `generateKeyPairWithSeed()`
-
-Generates a new Nostr key pair with seed phrase. This is useful when you need to provide users with a recoverable key pair.
-
-**Returns:**
-```typescript
-{
-  seedPhrase: string;  // BIP39 seed phrase for key recovery
-  nsec: string;        // Private key in bech32 format
-  npub: string;        // Public key in bech32 format
-  privateKey: string;  // Private key in hex format
-  publicKey: string;   // Public key in hex format
-}
-```
-
-### `nsecToSeed(nsec: string)`
-
-Converts a Nostr private key to a BIP39 seed phrase.
-
-**Parameters:**
-- `nsec`: The nsec format private key
-
-**Returns:** `string` - The BIP39 seed phrase
+### Key Management
+- `generateKeyPairWithSeed()`: Generate a new key pair with seed phrase
+- `seedPhraseToKeyPair(seedPhrase: string)`: Convert seed phrase to key pair
+- `fromHex(privateKeyHex: string)`: Create key pair from hex private key
+- `validateSeedPhrase(seedPhrase: string)`: Validate a seed phrase
 
-### `seedToNsec(seedPhrase: string)`
+### Format Conversion
+- `nsecToHex(nsec: string)`: Convert nsec to hex format
+- `npubToHex(npub: string)`: Convert npub to hex format
+- `hexToNsec(privateKeyHex: string)`: Convert hex to nsec format
+- `hexToNpub(publicKeyHex: string)`: Convert hex to npub format
 
-Converts a BIP39 seed phrase back to a Nostr key pair.
-
-**Parameters:**
-- `seedPhrase`: The BIP39 seed phrase
-
-**Returns:** `string` - The nsec format private key
-
-### `hexToNsec(hexPrivateKey: string)`
-
-Converts a hex private key to nsec format.
-
-**Parameters:**
-- `hexPrivateKey`: Hex string of the private key
-
-**Returns:** `Promise<string>` - The nsec format private key
-
-### `nsecToHex(nsec: string)`
-
-Converts an nsec private key to hex format.
-
-**Parameters:**
-- `nsec`: The nsec format private key
-
-**Returns:** `Promise<string>` - The hex format private key
-
-### `npubToHex(npub: string)`
-
-Converts an npub public key to hex format.
-
-**Parameters:**
-- `npub`: The npub format public key
-
-**Returns:** `Promise<string>` - The hex format public key
-
-### `hexToNpub(hexPublicKey: string)`
-
-Converts a hex public key to npub format.
-
-**Parameters:**
-- `hexPublicKey`: Hex string of the public key
-
-**Returns:** `Promise<string>` - The npub format public key
-
-## Security Best Practices
-
-1. **Never Share Private Keys**: Keep your nsec and private key hex values secure and never share them.
-2. **Backup Seed Phrases**: Safely store your seed phrase in a secure location.
-3. **Verify Keys**: Always verify key pairs after generation or conversion.
-4. **Environment Variables**: Use environment variables for storing sensitive keys in production.
-5. **Memory Management**: Clear sensitive data from memory when no longer needed.
+### Signing and Verification
+- `signMessage(message: string, privateKey: string)`: Sign a message
+- `verifySignature(message: string, signature: string, publicKey: string)`: Verify a signature
+- `createEvent(content: string, kind: number, privateKey: string, tags?: string[][])`: Create a Nostr event
+- `verifyEvent(event: NostrEvent)`: Verify a Nostr event
 
 ## Contributing
 
-We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
-
-## Testing
-
-Run the test suite:
-
-```bash
-npm test
-```
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Support
+[MIT](LICENSE)
 
-- Create an [Issue](https://github.com/HumanjavaEnterprises/nostr-nsec-seedphrase/issues)
-- Follow on [Nostr](https://snort.social/p/npub12xyl6w6aacmqa3gmmzwrr9m3u0ldx3dwqhczuascswvew9am9q4sfg99cx)
-- Follow on [X (Twitter)](https://x.com/vveerrgg)
+## Author
 
-## Acknowledgments
+[Vergel Evans](https://github.com/vergelevans)
 
-- [nostr-tools](https://github.com/nbd-wtf/nostr-tools) - For Nostr protocol utilities
-- [bip39](https://github.com/bitcoinjs/bip39) - For mnemonic generation
+---
+<div align="center">
+Made with ❤️ by <a href="https://github.com/humanjavaenterprises">Human Java Enterprises</a>
+</div>

mocks/mock-secp256k1.ts

@@ -0,0 +1,14 @@
+export const utils = {
+    hmacSha256: (key: Uint8Array, ...messages: Uint8Array[]): Uint8Array => {
+        // Mock implementation of HMAC SHA256
+        const result = new Uint8Array(32); // Dummy result
+        result.fill(1); // Fill with dummy data
+        return result;
+    },
+    hmacSha256Sync: (key: Uint8Array, ...messages: Uint8Array[]): Uint8Array => {
+        // Mock implementation of synchronous HMAC SHA256
+        const result = new Uint8Array(32); // Dummy result
+        result.fill(1); // Fill with dummy data
+        return result;
+    }
+};