create-agent 0.0.6 → 0.0.8

package/README.md

@@ -1,2 +1,113 @@
-# create-agent
-create an agent
+# create-agent 🤖
+
+A command-line tool to generate Agent keypairs with various encodings.
+
+## Installation 📦
+
+```bash
+npm install -g create-agent
+```
+
+Or simply run:
+
+```bash
+npm create agent
+```
+
+## Usage 🚀
+
+Simply run:
+
+```bash
+create-agent
+```
+
+The tool will generate a new Agent keypair and display it in various formats.
+
+## Output Fields 🔑
+
+The tool generates a JSON object containing:
+
+### Private Key Formats
+
+#### `privkey`
+
+- 32-byte private key in hexadecimal format
+- The private key of the Agent
+- Used to sign Nostr events
+- Example:
+  ```
+  "7f7168866801e2003bfc6507f881783e23587d35ece7b1f1981891b9c9c26c55"
+  ```
+- ⚠️ **Keep this secret!**
+
+#### `nsec`
+
+- Bech32-encoded private key (starts with `nsec`)
+- Human-friendly format
+- Example:
+  ```
+  "nsec1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq3vk8rx"
+  ```
+- ⚠️ **Keep this secret!**
+
+### Public Key Formats
+
+#### `pubkey`
+
+- 32-byte public key in hexadecimal format
+- Derived from private key using Schnorr signatures
+- Your identity in the Nostr network
+- Example:
+  ```
+  "06444f34c6c5f973d74b3c78214fd0bf694f0cf459651b2ffe651fa08ba00bf4"
+  ```
+
+#### `npub`
+
+- Bech32-encoded public key (starts with `npub`)
+- Human-friendly format for sharing
+- Example:
+  ```
+  "npub1sg6plzptd64u62a878hep2kev88swjh3tw00gjsfl8f237lmu63q0uf63m"
+  ```
+
+## Example Output 📝
+
+```json
+{
+  "privkey": "7f7168866801e2003bfc6507f881783e23587d35ece7b1f1981891b9c9c26c55",
+  "pubkey": "06444f34c6c5f973d74b3c78214fd0bf694f0cf459651b2ffe651fa08ba00bf4",
+  "nsec": "nsec1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq3vk8rx",
+  "npub": "npub1sg6plzptd64u62a878hep2kev88swjh3tw00gjsfl8f237lmu63q0uf63m"
+}
+```
+
+## Security Notice 🔒
+
+**Never share your private key!** Anyone with access to your private key (`privkey` or `nsec`) can:
+
+- ✍️ Post messages as you
+- 👤 Update your profile
+- 👥 Follow/unfollow other users
+- 📨 Send encrypted messages in your name
+
+## About Nostr 📡
+
+Nostr (Notes and Other Stuff Transmitted by Relays) is a decentralized social networking protocol. Each user is identified by a public key, and all actions are signed using their corresponding private key.
+
+## Development 🛠️
+
+```bash
+git clone https://github.com/melvincarvalho/create-agent.git
+cd create-agent
+npm install
+```
+
+## License 📄
+
+MIT
+
+---
+
+Made with ❤️ for the [Agentic Alliance](https://agenticalliance.com/) community

package/bin/create-agent.js

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
 
-// Use nostr-tools to generate secure keypair
+// =============================================================================
+// NOSTR KEY GENERATION
+// =============================================================================
 import { generateSecretKey, getPublicKey } from 'nostr-tools/pure';
 import { nip19 } from 'nostr-tools';
 
 // Generate cryptographically secure private key (32 bytes)
 const privkey = generateSecretKey();
-
-// Convert Uint8Array to hex string
 const privkeyHex = Array.from(privkey)
   .map(b => b.toString(16).padStart(2, '0'))
   .join('');
@@ -15,21 +15,62 @@ const privkeyHex = Array.from(privkey)
 // Derive public key using Schnorr signatures (32 bytes, hex encoded)
 const pubkey = getPublicKey(privkey);
 
-// Encode the private key as nsec
+// Encode keys in Nostr formats
 const nsec = nip19.nsecEncode(privkey);
-
-// Encode the public key as npub
 const npub = nip19.npubEncode(pubkey);
 
-// Cool console message
-console.error('\x1b[36m%s\x1b[0m', '🤖 Creating new agent...');
-console.error('\x1b[33m%s\x1b[0m', '⚠️  Keep your private key secret!');
-console.error('');
-
-// Output JSON with both keys, nsec and npub
-console.log(JSON.stringify({
-  privkey: privkeyHex,
-  pubkey: pubkey,
-  nsec: nsec,
-  npub: npub
-}, null, 2)); 
+// =============================================================================
+// DID DOCUMENT CREATION
+// =============================================================================
+const didDocument = {
+  "@context": [
+    "https://www.w3.org/ns/did/v1",
+    "https://w3id.org/nostr/context"
+  ],
+  "id": `did:nostr:${pubkey}`,
+  "verificationMethod": [
+    {
+      "id": `did:nostr:${pubkey}#key1`,
+      "controller": `did:nostr:${pubkey}`,
+      "type": "SchnorrVerification2025"
+    }
+  ],
+  "authentication": [
+    "#key1"
+  ],
+  "assertionMethod": [
+    "#key1"
+  ],
+  "service": []  // Empty services array
+};
+
+// =============================================================================
+// CONSOLE OUTPUT
+// =============================================================================
+// First output the initial warning message to stderr
+process.stderr.write('\x1b[36m🤖 Creating new Nostr agent identity...\x1b[0m\n');
+process.stderr.write('\x1b[36m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\x1b[0m\n');
+process.stderr.write('\x1b[33m⚠️  IMPORTANT: Keep your private key (nsec/privkey) secret!\x1b[0m\n');
+process.stderr.write('\x1b[33m   Never share it with anyone or input it on websites.\x1b[0m\n');
+process.stderr.write('\n');
+
+// Then output the Nostr identity information to stderr
+process.stderr.write('\n\x1b[32m📋 Your Nostr Identity:\x1b[0m\n');
+process.stderr.write('\x1b[32m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\x1b[0m\n');
+process.stderr.write(`\x1b[0mPublic Key (hex) : \x1b[33m${pubkey}\x1b[0m\n`);
+process.stderr.write(`\x1b[0mNostr Public Key : \x1b[33m${npub}\x1b[0m\n`);
+process.stderr.write(`\x1b[0mPrivate Key (hex): \x1b[31m${privkeyHex}\x1b[0m\n`);
+process.stderr.write(`\x1b[0mNostr Secret Key : \x1b[31m${nsec}\x1b[0m\n`);
+process.stderr.write('\n');
+process.stderr.write('\x1b[36m🔍 Usage:\x1b[0m\n');
+process.stderr.write('\x1b[0m- Use your npub to identify yourself to others\x1b[0m\n');
+process.stderr.write('\x1b[0m- Add relays to the services array for discovery\x1b[0m\n');
+process.stderr.write('\x1b[0m- Use nsec to sign into Nostr clients (handle with extreme care!)\x1b[0m\n');
+process.stderr.write('\n');
+
+
+// Then output the DID document to stdout with a clear header in the output
+process.stderr.write('\x1b[36m📄 DID Nostr Document:\x1b[0m\n');
+process.stderr.write('\x1b[36m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\x1b[0m\n');
+console.log(JSON.stringify(didDocument, null, 2));
+process.stderr.write('\x1b[36m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\x1b[0m\n');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-agent",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "create an agent",
   "main": "index.js",
   "scripts": {