nostr-crypto-utils 0.4.12 → 0.4.13

package/src/types/base.ts

@@ -3,212 +3,148 @@
  * @description Core type definitions for Nostr protocol
  */
 
-/**
- * Represents a public key in hex format
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
+// Key Types
 export type PublicKeyHex = string;
+export type PrivateKeyHex = string;
 
-/**
- * Represents a public key with additional formats
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
 export interface PublicKeyDetails {
   /** Public key in hex format */
   hex: string;
+  /** NIP-05 identifier */
+  nip05: string;
+  /** Public key in bytes format */
+  bytes: Uint8Array;
 }
 
-/**
- * Public key can be either a hex string or a detailed object
- */
 export type PublicKey = PublicKeyHex | PublicKeyDetails;
 
-/**
- * Key pair used for signing and encryption
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
 export interface KeyPair {
   /** Private key in hex format */
-  privateKey: string;
+  privateKey: PrivateKeyHex;
   /** Public key details */
   publicKey: PublicKeyDetails;
 }
 
-/**
- * Enum defining all possible Nostr event kinds as specified in various NIPs
- * @see https://github.com/nostr-protocol/nips
- */
+// Event Types
 export enum NostrEventKind {
-  /** NIP-01: Set metadata about the user */
+  // NIP-01: Core Protocol
   SET_METADATA = 0,
-  /** NIP-01: Plain text note */
   TEXT_NOTE = 1,
-  /** NIP-01: Recommend relay to followers */
   RECOMMEND_SERVER = 2,
-  /** NIP-02: Contact list and relay list metadata */
   CONTACTS = 3,
-  /** NIP-04: Encrypted direct message */
   ENCRYPTED_DIRECT_MESSAGE = 4,
-  /** NIP-09: Event deletion */
   EVENT_DELETION = 5,
-  /** NIP-25: Reactions to events */
+  REPOST = 6,
   REACTION = 7,
-  /** NIP-28: Channel creation */
-  CHANNEL_CREATE = 40,
-  /** NIP-28: Channel metadata */
+
+  // NIP-28: Public Chat
+  CHANNEL_CREATION = 40,
   CHANNEL_METADATA = 41,
-  /** NIP-28: Channel message */
   CHANNEL_MESSAGE = 42,
-  /** NIP-28: Hide message in channel */
   CHANNEL_HIDE_MESSAGE = 43,
-  /** NIP-28: Mute user in channel */
   CHANNEL_MUTE_USER = 44,
-  /** NIP-42: Authentication */
+
+  // NIP-42: Authentication
   AUTH = 22242,
-  /** NIP-42: Authentication response */
   AUTH_RESPONSE = 22243
 }
 
-/**
- * Basic Nostr event interface
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
-export interface NostrEvent {
+/** Base interface for all Nostr events */
+export interface BaseNostrEvent {
   /** Event kind as defined in NIPs */
-  kind: NostrEventKind;
+  kind: number;
   /** Content of the event */
   content: string;
-  /** Array of tags associated with the event */
+  /** Array of tags */
   tags: string[][];
   /** Unix timestamp in seconds */
   created_at: number;
-  /** Public key of the event creator in hex format */
-  pubkey: string;
 }
 
-/**
- * Signed Nostr event interface, extends NostrEvent with signature
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
-export interface SignedNostrEvent extends NostrEvent {
-  /** Event ID (32-bytes sha256 of the serialized event data) */
+/** Interface for events that haven't been signed yet */
+export interface UnsignedNostrEvent extends BaseNostrEvent {
+  /** Optional public key */
+  pubkey?: string;
+}
+
+/** Interface for signed events */
+export interface SignedNostrEvent extends BaseNostrEvent {
+  /** Public key of the event creator */
+  pubkey: string;
+  /** Event ID (sha256 of the serialized event) */
   id: string;
   /** Schnorr signature of the event ID */
   sig: string;
 }
 
-/**
- * Result of a validation operation
- */
-export interface ValidationResult {
-  /** Whether the validation passed */
-  isValid: boolean;
-  /** Error message if validation failed */
-  error?: string;
-}
+/** Alias for backward compatibility */
+export type NostrEvent = SignedNostrEvent;
 
-/**
- * Filter for Nostr events
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
+/** Type for creating new events */
+export type UnsignedEvent = Omit<NostrEvent, 'id' | 'sig'>;
+
+// Filter Types
 export interface NostrFilter {
-  /** Filter by event IDs */
   ids?: string[];
-  /** Filter by author public keys */
   authors?: string[];
-  /** Filter by event kinds */
   kinds?: NostrEventKind[];
-  /** Filter by start timestamp */
   since?: number;
-  /** Filter by end timestamp */
   until?: number;
-  /** Limit number of results */
   limit?: number;
-  /** Filter by event references */
   '#e'?: string[];
-  /** Filter by pubkey references */
   '#p'?: string[];
-  /** Filter by arbitrary tag */
-  [key: `#${string}`]: string[] | undefined;
-  /** Full-text search query */
   search?: string;
+  /** Support for arbitrary tags (NIP-12) */
+  [key: `#${string}`]: string[] | undefined;
 }
 
-/**
- * Subscription for Nostr events
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
 export interface NostrSubscription {
-  /** Unique subscription identifier */
   id: string;
-  /** Array of filters to apply to the subscription */
   filters: NostrFilter[];
 }
 
-/**
- * Nostr message types for client-relay communication
- * @see https://github.com/nostr-protocol/nips/blob/master/01.md
- */
+// Message Types
 export enum NostrMessageType {
   EVENT = 'EVENT',
-  REQ = 'REQ',
-  CLOSE = 'CLOSE',
   NOTICE = 'NOTICE',
-  EOSE = 'EOSE',
   OK = 'OK',
-  AUTH = 'AUTH',
-  ERROR = 'ERROR',
-  COUNT = 'COUNT'
+  EOSE = 'EOSE',
+  REQ = 'REQ',
+  CLOSE = 'CLOSE',
+  AUTH = 'AUTH'
 }
 
-/**
- * Nostr message interface
- */
 export interface NostrMessage {
-  /** Type of the message */
   type: NostrMessageType;
-  /** Payload of the message */
-  payload: unknown;
+  event?: SignedNostrEvent;
+  subscriptionId?: string;
+  filters?: NostrFilter[];
+  eventId?: string;
+  accepted?: boolean;
+  message?: string;
+  count?: number;
+  payload?: string | (string | boolean)[];  
 }
 
-/**
- * Nostr response interface
- */
 export interface NostrResponse {
-  /** Type of the response */
   type: NostrMessageType;
-  /** Event data if applicable */
   event?: SignedNostrEvent;
-  /** Subscription ID if applicable */
   subscriptionId?: string;
-  /** Filters if applicable */
   filters?: NostrFilter[];
-  /** Event ID if applicable */
   eventId?: string;
-  /** Whether the request was accepted */
   accepted?: boolean;
-  /** Message if applicable */
   message?: string;
+  count?: number;
+}
+
+// Utility Types
+export interface ValidationResult {
+  isValid: boolean;
+  error?: string;
 }
 
-/**
- * Nostr error interface
- */
 export interface NostrError {
-  /** Error code */
   code: string;
-  /** Error message */
   message: string;
-  /** Additional error details */
   details?: Record<string, unknown>;
 }
-
-/**
- * Encryption result interface
- */
-export interface EncryptionResult {
-  /** Encrypted ciphertext */
-  ciphertext: string;
-  /** Initialization vector */
-  iv: string;
-}

package/src/utils/encoding.ts

@@ -25,3 +25,21 @@ export function bytesToHex(bytes: Uint8Array): string {
         .map(b => b.toString(16).padStart(2, '0'))
         .join('');
 }
+
+/**
+ * Convert a UTF-8 string to Uint8Array
+ * @param str UTF-8 string to convert
+ * @returns Uint8Array of bytes
+ */
+export function utf8ToBytes(str: string): Uint8Array {
+    return new TextEncoder().encode(str);
+}
+
+/**
+ * Convert Uint8Array to UTF-8 string
+ * @param bytes Uint8Array to convert
+ * @returns UTF-8 string
+ */
+export function bytesToUtf8(bytes: Uint8Array): string {
+    return new TextDecoder().decode(bytes);
+}