neozipkit 0.2.1 → 0.3.0

package/src/node/index.ts

@@ -0,0 +1,69 @@
+/**
+ * Node Module Exports
+ * Node.js functionality for ZIP file processing and blockchain operations
+ * 
+ * This is the entry point for Node.js-only imports:
+ * import ZipkitNode from 'neozipkit/node';
+ * // or
+ * import { Zipkit, ZipkitNode, ... } from 'neozipkit/node';
+ */
+
+// Core ZIP functionality (re-exported from core module, but NOT the default)
+export * from '../core';
+import Zipkit from '../core';
+export { Zipkit }; // Named export for backward compatibility
+
+// Node.js-specific ZIP operations - default export (after export * to ensure it's the default)
+import ZipkitNodeDefault from './ZipkitNode';
+export { default as ZipkitNode } from './ZipkitNode';
+// Set as default export - this will be the default when importing from this module
+export default ZipkitNodeDefault;
+export type { ZipFileWriter } from './ZipkitNode';
+export { ZipCompressNode } from './ZipCompressNode';
+export { ZipDecompressNode } from './ZipDecompressNode';
+
+// Blockchain Node.js functionality
+export { 
+  WalletManagerNode, 
+  ZipkitWallet,
+  ZipkitMinter,
+  ZipkitVerifier,
+  CoreWalletManager,
+  WalletAnalyzer,
+  createTimestamp,
+  verifyOts,
+  verifyOtsZip
+} from '../blockchain';
+export type { 
+  EnhancedVerificationResult, 
+  BatchVerificationResult, 
+  VerificationJob,
+  MintingOptions,
+  MintingResult,
+  VerificationOptions,
+  VerificationResult,
+  WalletInfo,
+  NetworkConfig,
+  TokenMetadata,
+  WalletSetupResult,
+  CommonTokenConfig,
+  TokenInfo,
+  WalletBasicInfo,
+  TokenScanResult,
+  NZipTokenDetails,
+  TimestampResult,
+  TimestampInfo,
+  DeserializeOtsResult,
+  OtsVerifyResult
+} from '../blockchain';
+
+// Timestamp verification
+export { verifyOts as verifyTimestamp } from '../blockchain/core/ZipkitOTS';
+
+// Platform detection
+export const PlatformUtils = {
+  // Browser detection
+  isBrowser: typeof window !== 'undefined' && typeof document !== 'undefined',
+  // Node.js detection  
+  isNode: typeof process !== 'undefined' && process.versions && process.versions.node,
+};

package/src/types/index.ts

@@ -1,3 +1,122 @@
+import type { Wallet, JsonRpcProvider } from 'ethers';
+
+// ============================================================================
+// Wallet and Network Types
+// ============================================================================
+
+export interface WalletInfo {
+  address: string;
+  privateKey: string;
+  mnemonic: string;
+}
+
+export interface NetworkConfig {
+  name: string;
+  rpcUrl: string;
+  chainId: number;
+  explorerUrl: string;
+}
+
+export interface WalletSetupResult {
+  wallet: Wallet | null;
+  provider: JsonRpcProvider | null;
+  success: boolean;
+  message?: string;
+}
+
+export interface MintingResult {
+  success: boolean;
+  message: string;
+  tokenId?: string;
+  txHash?: string;
+  creationTimestamp?: number;
+}
+
+export interface MintingOptions {
+  wallet?: string;
+  network: string;
+  mintToken: boolean;
+}
+
+// ============================================================================
+// Token Metadata
+// ============================================================================
+
+// Canonical token metadata used across minting, verification, and ZIP embedding
+export interface TokenMetadata {
+  // Core identifiers
+  tokenId: string;
+  contractAddress: string;
+  network: string;
+  merkleRoot: string;
+
+  // Optional chain info
+  networkChainId?: number;
+  transactionHash?: string;
+  blockNumber?: number;
+  owner?: string;
+
+  // Names and timestamps (support mintedAt/mintDate)
+  mintedAt?: string;
+  mintDate?: string;
+  creationTimestamp?: number;
+
+  // Optional content link
+  ipfsHash?: string;
+
+  // Versioning
+  version?: string;
+}
+
+// ============================================================================
+// Network Configuration
+// ============================================================================
+
+export const NETWORKS: Record<string, NetworkConfig> = {
+  'base': {
+    name: 'Base Mainnet',
+    rpcUrl: 'https://mainnet.base.org',
+    chainId: 8453,
+    explorerUrl: 'https://basescan.org'
+  },
+  'base-sepolia': {
+    name: 'Base Sepolia',
+    rpcUrl: 'https://sepolia.base.org',
+    chainId: 84532,
+    explorerUrl: 'https://sepolia.basescan.org'
+  },
+  'base-goerli': {
+    name: 'Base Goerli',
+    rpcUrl: 'https://goerli.base.org',
+    chainId: 84531,
+    explorerUrl: 'https://goerli.basescan.org'
+  },
+  'localhost': {
+    name: 'Localhost',
+    rpcUrl: 'http://localhost:8545',
+    chainId: 31337,
+    explorerUrl: 'http://localhost:8545'
+  }
+};
+
+// ============================================================================
+// NeoZipKit Version Info
+// ============================================================================
+
+export interface NeoZipKitInfo {
+  version: string;
+  releaseDate: string;
+}
+
+export const NEOZIPKIT_INFO: NeoZipKitInfo = {
+  version: '0.70.0-alpha',
+  releaseDate: '2024-10-04'
+};
+
+// ============================================================================
+// File Data Interfaces
+// ============================================================================
+
 export interface FileData {
   name: string;
   size: number;
@@ -6,9 +125,20 @@ export interface FileData {
 }
 
 export interface ZipFileEntry {
+  filename: string;
+  comment?: string | null;
   fileData?: FileData;
+  fileBuffer?: Buffer | null;
+  isDirectory: boolean;
+  isMetaData: boolean;
+  isEncrypted: boolean;
+  sha256?: string | null;
 }
 
+// ============================================================================
+// Support Interface
+// ============================================================================
+
 export interface Support {
   base64: boolean;
   array: boolean;
@@ -22,4 +152,4 @@ export interface Support {
   fileReader: boolean;
 }
 
-// External module types are handled by installed @types packages 
+// External module types are handled by installed @types packages

package/src/types/modules.d.ts

@@ -3,16 +3,6 @@ declare module 'pako' {
   export function inflateRaw(data: Uint8Array | Buffer): Buffer;
 }
 
-// Minimal typings to satisfy TS in environments without @types/moment-timezone
-declare module 'moment' {
-  const moment: any;
-  export default moment;
-}
-declare module 'moment-timezone' {
-  const momentTz: any;
-  export default momentTz;
-}
-
 declare module 'opentimestamps' {
   export class Ops {
     static OpSHA256: any;
@@ -29,4 +19,4 @@ declare module 'opentimestamps' {
   export function upgrade(ots: DetachedTimestampFile): Promise<boolean>;
   export function verify(ots: DetachedTimestampFile, hash: DetachedTimestampFile, options?: any): Promise<any>;
   export function info(detached: DetachedTimestampFile): string;
-}
+} 

package/src/types/opentimestamps.d.ts

@@ -1,23 +1 @@
-/**
- * Type declarations for OpenTimestamps module
- */
-declare module 'opentimestamps' {
-  namespace stamp {
-    function create(fileBuffer: Buffer): Promise<Buffer>;
-  }
-
-  namespace verify {
-    function verifyTimestamp(ots: Buffer, fileHash: Buffer): Promise<any>;
-  }
-
-  namespace utils {
-    function hexToBytes(hex: string): number[];
-    function bytesToHex(bytes: number[]): string;
-  }
-
-  export default {
-    stamp,
-    verify,
-    utils
-  };
-} 
+declare module 'opentimestamps';

package/contracts/INTEGRATION.md

@@ -1,338 +0,0 @@
-# Contract Integration Guide
-
-This guide shows how to integrate NeoZipKit smart contracts into your application.
-
-## 🚀 Quick Integration
-
-### Basic Setup
-
-```typescript
-import { ZipTokenProcessor, MintingOptions } from 'neozipkit/server/blockchain';
-
-// Configure minting options
-const options: MintingOptions = {
-  contractAddress: 'YOUR_DEPLOYED_CONTRACT_ADDRESS',
-  network: 'base-sepolia',
-  mintToken: true
-};
-
-// Create processor
-const processor = new ZipTokenProcessor('archive.zip', 'merkle_root_hash', options);
-
-// Process and mint token
-const result = await processor.processZipToken(options);
-```
-
-### Environment Configuration
-
-```bash
-# Required environment variables
-export RPC_URL="https://sepolia.base.org"
-export NETWORK="base-sepolia"
-export CONTRACT_ADDRESS="0xYourDeployedContractAddress"
-```
-
-## 🔧 Core Components
-
-### TokenVerifier
-Verify tokenized ZIP files against blockchain:
-
-```typescript
-import { TokenVerifier } from 'neozipkit/server/blockchain/TokenVerifier';
-
-const verifier = new TokenVerifier({
-  network: 'base-sepolia',
-  contractAddress: '0xYourContractAddress'
-});
-
-const isValid = await verifier.verifyToken(tokenId, merkleRoot);
-```
-
-### NFTMinter
-Mint NFTs for ZIP files:
-
-```typescript
-import { NFTMinter } from 'neozipkit/server/blockchain/NFTMinter';
-
-const minter = new NFTMinter({
-  network: 'base-sepolia',
-  contractAddress: process.env.CONTRACT_ADDRESS
-});
-
-const tokenId = await minter.mintToken({
-  to: '0xRecipientAddress',
-  merkleRoot: 'merkle_root_hash',
-  metadata: {
-    name: 'My ZIP Archive',
-    description: 'Tokenized ZIP file',
-    // ... additional metadata
-  }
-});
-```
-
-### TokenQuerier
-Query token information from blockchain:
-
-```typescript
-import { TokenQuerier } from 'neozipkit/server/blockchain/TokenQuerier';
-
-const querier = new TokenQuerier({
-  network: 'base-sepolia',
-  contractAddress: '0xYourContractAddress'
-});
-
-// Get token metadata
-const metadata = await querier.getTokenMetadata(tokenId);
-
-// Get token owner
-const owner = await querier.getTokenOwner(tokenId);
-
-// Check if token exists
-const exists = await querier.tokenExists(tokenId);
-```
-
-### WalletManager
-Manage wallet connections and networks:
-
-```typescript
-import { WalletManager } from 'neozipkit/server/blockchain/WalletManager';
-
-const walletManager = new WalletManager({
-  network: 'base-sepolia',
-  rpcUrl: process.env.RPC_URL
-});
-
-// Get wallet balance
-const balance = await walletManager.getBalance();
-
-// Get network information
-const networkInfo = await walletManager.getNetworkInfo();
-```
-
-## 🌐 Browser Integration
-
-### Browser-Compatible Components
-
-```typescript
-import { TokenVerifierBrowser } from 'neozipkit/browser';
-
-const verifier = new TokenVerifierBrowser({
-  network: 'base-sepolia',
-  rpcUrl: 'https://sepolia.base.org',
-  contractAddress: '0xYourContractAddress'
-});
-
-// Verify token (read-only operation)
-const isValid = await verifier.verifyToken(tokenId, merkleRoot);
-```
-
-### Web3 Wallet Integration
-
-```typescript
-// Connect to user's wallet (MetaMask, etc.)
-if (window.ethereum) {
-  const provider = new ethers.providers.Web3Provider(window.ethereum);
-  await provider.send("eth_requestAccounts", []);
-  
-  const signer = provider.getSigner();
-  const userAddress = await signer.getAddress();
-  
-  // Use with NeoZipKit components
-  const minter = new NFTMinter({
-    signer: signer,
-    contractAddress: process.env.CONTRACT_ADDRESS
-  });
-}
-```
-
-## 📝 Complete Example
-
-### Server-Side Token Creation
-
-```typescript
-import { 
-  ZipTokenProcessor, 
-  NFTMinter, 
-  TokenVerifier 
-} from 'neozipkit/server/blockchain';
-
-async function createAndVerifyToken() {
-  try {
-    // 1. Process ZIP file and create Merkle root
-    const processor = new ZipTokenProcessor('archive.zip', null, {
-      network: 'base-sepolia',
-      contractAddress: process.env.CONTRACT_ADDRESS
-    });
-    
-    const { merkleRoot, zipHash } = await processor.generateHashes();
-    
-    // 2. Mint NFT token
-    const minter = new NFTMinter({
-      network: 'base-sepolia',
-      contractAddress: process.env.CONTRACT_ADDRESS
-    });
-    
-    const tokenId = await minter.mintToken({
-      to: '0xRecipientAddress',
-      merkleRoot: merkleRoot,
-      metadata: {
-        name: 'Archive Token',
-        description: 'Verified ZIP archive',
-        zipHash: zipHash
-      }
-    });
-    
-    console.log(`Token minted with ID: ${tokenId}`);
-    
-    // 3. Verify the token
-    const verifier = new TokenVerifier({
-      network: 'base-sepolia',
-      contractAddress: process.env.CONTRACT_ADDRESS
-    });
-    
-    const isValid = await verifier.verifyToken(tokenId, merkleRoot);
-    console.log(`Token verification: ${isValid ? 'VALID' : 'INVALID'}`);
-    
-    return { tokenId, merkleRoot, isValid };
-    
-  } catch (error) {
-    console.error('Error creating token:', error);
-    throw error;
-  }
-}
-```
-
-### Client-Side Token Verification
-
-```typescript
-import { TokenVerifierBrowser } from 'neozipkit/browser';
-
-async function verifyTokenFromBrowser(tokenId: string, merkleRoot: string) {
-  const verifier = new TokenVerifierBrowser({
-    network: 'base-sepolia',
-    rpcUrl: 'https://sepolia.base.org',
-    contractAddress: '0xYourContractAddress'
-  });
-  
-  try {
-    const isValid = await verifier.verifyToken(tokenId, merkleRoot);
-    
-    if (isValid) {
-      console.log('✅ Token is valid and verified on blockchain');
-    } else {
-      console.log('❌ Token verification failed');
-    }
-    
-    return isValid;
-    
-  } catch (error) {
-    console.error('Verification error:', error);
-    return false;
-  }
-}
-```
-
-## 🔒 Security Best Practices
-
-### Contract Address Management
-
-```typescript
-// ✅ DO: Use environment variables for contract addresses
-const contractAddress = process.env.CONTRACT_ADDRESS;
-
-// ✅ DO: Validate contract addresses
-import { ethers } from 'ethers';
-if (!ethers.utils.isAddress(contractAddress)) {
-  throw new Error('Invalid contract address');
-}
-```
-
-### Input Validation
-
-```typescript
-import { ethers } from 'ethers';
-
-function validateInputs(tokenId: string, address: string) {
-  // Validate token ID
-  if (!tokenId || !/^\d+$/.test(tokenId)) {
-    throw new Error('Invalid token ID');
-  }
-  
-  // Validate Ethereum address
-  if (!ethers.utils.isAddress(address)) {
-    throw new Error('Invalid Ethereum address');
-  }
-}
-```
-
-### Error Handling
-
-```typescript
-async function safeTokenOperation() {
-  try {
-    const result = await processor.processZipToken(options);
-    return result;
-  } catch (error) {
-    if (error.code === 'NETWORK_ERROR') {
-      console.error('Network connectivity issue');
-    } else if (error.code === 'CONTRACT_ERROR') {
-      console.error('Contract interaction failed');
-    } else {
-      console.error('Unexpected error:', error.message);
-    }
-    
-    // Log error for monitoring
-    logger.error('Token operation failed', { error, options });
-    
-    throw error;
-  }
-}
-```
-
-## 📊 Monitoring and Analytics
-
-### Event Listening
-
-```typescript
-import { ethers } from 'ethers';
-
-// Listen for token mint events
-const contract = new ethers.Contract(contractAddress, abi, provider);
-
-contract.on('Transfer', (from, to, tokenId) => {
-  if (from === ethers.constants.AddressZero) {
-    console.log(`New token minted: ${tokenId} to ${to}`);
-    // Log to analytics
-    analytics.track('token_minted', { tokenId, recipient: to });
-  }
-});
-```
-
-### Health Monitoring
-
-```typescript
-async function checkContractHealth() {
-  try {
-    const querier = new TokenQuerier({
-      network: process.env.NETWORK,
-      contractAddress: process.env.CONTRACT_ADDRESS
-    });
-    
-    // Check if contract is responding
-    const totalSupply = await querier.getTotalSupply();
-    
-    return {
-      status: 'healthy',
-      totalSupply: totalSupply,
-      timestamp: new Date().toISOString()
-    };
-    
-  } catch (error) {
-    return {
-      status: 'unhealthy',
-      error: error.message,
-      timestamp: new Date().toISOString()
-    };
-  }
-}
-```