neozipkit 0.1.1 → 0.2.1

package/contracts/README.md

@@ -0,0 +1,152 @@
+# NeoZipKit Smart Contracts
+
+This directory contains production-ready smart contracts for ZIP file tokenization and their deployment utilities.
+
+## 🎯 Contract Types
+
+### 🌐 Main Contract (`NZIP-NFT.sol`)
+- **Universal verification** - Anyone can verify any token
+- **Public blockchain metadata** - All data visible on blockchain
+- **Use cases**: Certificates, public records, open-source projects, general tokenization
+- **Symbol**: `NZIP`
+
+## 📍 Current Deployment
+
+**✅ Production Contract (v2.0)**:
+```
+Address: 0xFD76a5d420704F34d84b0767961835c43D7b30a8
+Network: Base Sepolia
+Version: 2.0.0
+Status: ✅ ACTIVE - Use for all new integrations
+Explorer: https://sepolia.basescan.org/address/0xFD76a5d420704F34d84b0767961835c43D7b30a8
+```
+
+## 🔧 Supported Features
+
+- **NFT Tokenization**: Convert ZIP files into ERC-721 NFTs with complete metadata
+- **Blockchain Verification**: Verify ZIP file authenticity against blockchain tokens
+- **OpenTimestamps**: Bitcoin blockchain timestamping for file integrity
+- **Multi-Network Support**: Base Mainnet, Base Sepolia, Ethereum, Polygon, Arbitrum
+- **Smart Contracts**: Production-ready contracts for public and private tokenization
+
+## 🏗️ Blockchain Components
+
+- **`TokenVerifier`** - Verify tokenized ZIP files against blockchain
+- **`NFTMinter`** - Mint NFTs for ZIP files
+- **`TokenQuerier`** - Query token information from blockchain
+- **`CertificateToken`** - Generate certificates for tokenized files
+- **`ZipTokenProcessor`** - Process ZIP files for tokenization
+- **`WalletManager`** - Manage wallet connections and networks
+
+## 📁 Directory Structure
+
+```
+contracts/
+├── src/                           # Smart contract source files
+│   ├── NZIP-NFT.sol              # Main tokenization contract
+│   ├── NZIP-NFT-Private.sol      # Private tokenization contract
+│   └── *.sol                     # Legacy and deprecated contracts
+├── constants.ts                   # Contract addresses and deployment info
+└── *.md                          # Documentation files
+```
+
+## 🚀 Quick Start
+
+1. **Deploy contract using Remix IDE**:
+   - Open [Remix IDE](https://remix.ethereum.org/)
+   - Upload contract files from `src/` directory
+   - Compile and deploy using Remix 
+
+2. **Integrate with your application**:
+   ```typescript
+   import { ZipTokenProcessor, MintingOptions } from 'neozipkit/server/blockchain';
+   
+   const options: MintingOptions = {
+     wallet: 'path/to/wallet.json',
+     network: 'base-sepolia',
+     mintToken: true
+   };
+
+   const processor = new ZipTokenProcessor('archive.zip', 'merkle_root_hash', options);
+   const result = await processor.processZipToken(options);
+
+   if (result.error) {
+     console.error('Processing failed:', result.error);
+   } else {
+     console.log('Success!', result);
+   }
+   ```
+3. **Command-line deployment scripts**
+
+   - Base Mainnet
+     ```bash
+     cd /Users/stevenburg/Projects/NeoWare/neozipkit
+     export PRIVATE_KEY=0xYOUR_DEPLOYER_PRIVATE_KEY
+     export BASE_RPC_URL=https://mainnet.base.org
+     node contracts/deploy-bytecode.mjs
+     ```
+
+   - Base Sepolia
+     ```bash
+     cd /Users/stevenburg/Projects/NeoWare/neozipkit
+     export PRIVATE_KEY=0xYOUR_DEPLOYER_PRIVATE_KEY
+     export NETWORK=base-sepolia
+     export BASE_RPC_URL=https://sepolia.base.org
+     node contracts/deploy-bytecode.mjs
+     ```
+
+   - Ethereum Mainnet
+     ```bash
+     cd /Users/stevenburg/Projects/NeoWare/neozipkit
+     export PRIVATE_KEY=0xYOUR_DEPLOYER_PRIVATE_KEY
+     export NETWORK=eth
+     export ETH_RPC_URL=https://mainnet.infura.io/v3/YOUR_KEY
+     node contracts/deploy-bytecode.mjs
+     ```
+
+## 📦 Contract Constants and ABI
+
+Contract addresses and deployment info are in `contracts/constants.ts`, while the ABI is in `src/blockchain/abi.ts`.
+
+**Contract Constants** (`contracts/constants.ts`):
+- `CONTRACT_ADDRESSES`: ChainId → address map (`NZIP_NFT` group)
+- `DEPRECATED_CONTRACTS`: Historical addresses
+- `CURRENT_DEPLOYMENT`: Current network, chainId, address, and tx/explorer info
+
+**Contract ABI** (`src/blockchain/abi.ts`):
+- `NZIP_CONTRACT_ABI`: Full contract ABI for integration
+
+Example usage:
+```ts
+// For deployment scripts and contract management
+import { CONTRACT_ADDRESSES, CURRENT_DEPLOYMENT } from '../contracts/constants';
+
+// For application integration
+import { NZIP_CONTRACT_ABI } from 'neozipkit/blockchain/abi';
+import { CONTRACT_ADDRESSES } from 'neozipkit/blockchain/constants';
+
+const baseSepolia = CONTRACT_ADDRESSES.NZIP_NFT[84532];
+console.log('Base Sepolia NZIP‑NFT:', baseSepolia);
+console.log('ABI functions:', NZIP_CONTRACT_ABI.map((f: any) => f.name).filter(Boolean));
+```
+
+## 🔐 Security Considerations
+
+### Development Best Practices
+
+- **Private Keys**: Never commit private keys or mnemonics to version control
+- **Network Security**: Use secure RPC endpoints and validate all inputs
+- **Smart Contract Audits**: Audit contracts before production deployment
+- **Error Handling**: Implement comprehensive error handling for all operations
+- **Type Safety**: Leverage TypeScript for compile-time error detection
+
+### File Verification
+
+- **Merkle Trees**: All ZIP files use cryptographic Merkle trees for integrity verification
+- **Blockchain Anchoring**: Timestamps and hashes are anchored to blockchain networks
+- **Multi-Layer Verification**: Support for both OpenTimestamps and NFT-based verification
+
+## 📄 Additional Documentation
+
+- **[Network Configuration](./NETWORKS.md)** - Supported networks and configuration
+- **[Integration Guide](./INTEGRATION.md)** - How to integrate contracts with your application

package/{src/server/blockchain → contracts}/constants.ts

@@ -4,8 +4,8 @@
 export const CONTRACT_ADDRESSES = {
   NZIP_NFT: {
     84532: "0xFD76a5d420704F34d84b0767961835c43D7b30a8", // Current v2.0 contract
-    8453: "", // To be configured when deploying to mainnet
-    1: "",     // Ethereum Mainnet
+    8453: "0x2716c4609fD97DaEdF429BC4B4Ec2faa81e2cC60",  // Base Mainnet
+    1: "",     // Ethereum Mainnet - set after deployment
     11155111: "", // Sepolia Testnet  
     137: "",   // Polygon
     42161: "", // Arbitrum
@@ -936,25 +936,6 @@ export const NZIP_CONTRACT_ABI = [
   }
 ];
 
-/**
- * Helper function to get contract address for a chain
- */
-export function getNZipContractAddress(chainId: number): string {
-  return CONTRACT_ADDRESSES.NZIP_NFT[chainId] || "";
-}
-
-/**
- * Network configurations
- */
-export const NETWORK_CONFIG: Record<number, string> = {
-  1: "Ethereum Mainnet",
-  11155111: "Sepolia Testnet", 
-  84532: "Base Sepolia",
-  8453: "Base Mainnet",
-  137: "Polygon",
-  42161: "Arbitrum",
-};
-
 /**
  * Current deployment information
  */
@@ -966,4 +947,6 @@ export const CURRENT_DEPLOYMENT = {
   deployedAt: "2024-11-29", // Update when deploying to new networks
   txHash: "0x7f12a5974b6e6ee6cbb8bc6068b6d784fcc448a6fc567d1cc8a34b98a48efd9f",
   explorer: "https://sepolia.basescan.org/address/0xFD76a5d420704F34d84b0767961835c43D7b30a8"
-}; 
+};
+
+

package/contracts/deploy-bytecode.mjs

@@ -0,0 +1,94 @@
+// NZIP-NFT deployment script using precompiled bytecode
+// Usage (Base Mainnet):
+//   env PRIVATE_KEY=0x... BASE_RPC_URL=https://mainnet.base.org node contracts/deploy-bytecode.mjs
+// Usage (Base Sepolia):
+//   env PRIVATE_KEY=0x... NETWORK=base-sepolia BASE_RPC_URL=https://sepolia.base.org node contracts/deploy-bytecode.mjs
+// Usage (Ethereum Mainnet):
+//   env PRIVATE_KEY=0x... NETWORK=eth ETH_RPC_URL=https://mainnet.infura.io/v3/<KEY> node contracts/deploy-bytecode.mjs
+// Optional env:
+//   BYTECODE_PATH=contracts/NZIP-NFT-bytecode.txt
+//   NETWORK=base | base-sepolia | eth
+
+import fs from 'node:fs';
+import path from 'node:path';
+
+const { ethers } = await import('ethers');
+
+const NETWORK = process.env.NETWORK || 'base';
+const DEFAULT_RPCS = {
+  'base': 'https://mainnet.base.org',
+  'base-sepolia': 'https://sepolia.base.org',
+  'eth': 'https://eth.llamarpc.com',
+};
+
+const PRIVATE_KEY = process.env.PRIVATE_KEY;
+// Prefer network-specific env var, then fall back to defaults
+const RPC_URL = (
+  NETWORK === 'eth'
+    ? process.env.ETH_RPC_URL
+    : process.env.BASE_RPC_URL
+) || DEFAULT_RPCS[NETWORK] || DEFAULT_RPCS['base'];
+const BYTECODE_PATH = process.env.BYTECODE_PATH || path.join(process.cwd(), 'contracts', 'NZIP-NFT-bytecode.txt');
+
+if (!PRIVATE_KEY) {
+  console.error('Error: PRIVATE_KEY env var is required');
+  process.exit(1);
+}
+
+function loadBytecode(filePath) {
+  const raw = fs.readFileSync(filePath, 'utf8').trim();
+  if (!raw) throw new Error(`Empty bytecode in ${filePath}`);
+  return raw.startsWith('0x') ? raw : '0x' + raw;
+}
+
+async function main() {
+  console.log(`Deploying NZIP-NFT bytecode to ${NETWORK} via ${RPC_URL}`);
+  const provider = new ethers.JsonRpcProvider(RPC_URL);
+  const wallet = new ethers.Wallet(PRIVATE_KEY, provider);
+
+  const bytecode = loadBytecode(BYTECODE_PATH);
+
+  const [nonce, balanceWei] = await Promise.all([
+    provider.getTransactionCount(wallet.address),
+    provider.getBalance(wallet.address),
+  ]);
+  console.log('Deployer address:', wallet.address);
+  console.log('Deployer balance:', ethers.formatEther(balanceWei), 'ETH');
+  const fee = await provider.getFeeData();
+  const txReq = {
+    from: wallet.address,
+    data: bytecode,
+    // EIP-1559 fields if available
+    maxFeePerGas: fee.maxFeePerGas ?? undefined,
+    maxPriorityFeePerGas: fee.maxPriorityFeePerGas ?? undefined,
+  };
+
+  const gasLimit = await wallet.estimateGas(txReq).catch(() => null);
+  if (gasLimit) {
+    txReq.gasLimit = gasLimit;
+    console.log('Estimated gas limit:', gasLimit.toString());
+  } else {
+    console.log('Estimated gas limit: unavailable (provider failed to estimate)');
+  }
+
+  console.log('Sending deployment tx...');
+  const tx = await wallet.sendTransaction(txReq);
+  console.log('Tx hash:', tx.hash);
+  const receipt = await tx.wait();
+
+  if (!receipt || !receipt.contractAddress) {
+    console.error('Deployment failed or contractAddress not returned. Receipt:', receipt);
+    process.exit(1);
+  }
+
+  console.log('Deployed contract address:', receipt.contractAddress);
+  console.log('Block number:', receipt.blockNumber);
+  console.log('NOTE: Update src/server/blockchain/constants.ts with this address for the corresponding chainId.');
+}
+
+main().catch((err) => {
+  console.error('Deployment error:', err);
+  process.exit(1);
+});
+
+

package/dist/blockchain/ZipKitMinter.d.ts

@@ -0,0 +1,106 @@
+#!/usr/bin/env node
+/**
+ * ZipKitMinter - Handles NFT token minting for ZIP files
+ * Minter API for NZIP-NFT smart contract.
+ */
+import type { TokenMetadata } from './types';
+export interface MintingOptions {
+    walletPrivateKey: string;
+    network: string;
+    verbose?: boolean;
+    debug?: boolean;
+}
+export interface MintingResult {
+    success: boolean;
+    message: string;
+    tokenId?: string;
+    transactionHash?: string;
+    contractAddress?: string;
+    blockNumber?: number;
+    walletAddress?: string;
+    gasUsed?: string;
+    gasCost?: string;
+}
+export interface TokenInfo {
+    tokenId: string;
+    owner: string;
+    isOwnedByUser: boolean;
+    tokenData?: any;
+}
+export interface DuplicateCheckResult {
+    hasExistingTokens: boolean;
+    allTokens: TokenInfo[];
+    userOwnedTokens: TokenInfo[];
+    othersTokens: TokenInfo[];
+}
+export interface WalletInfo {
+    address: string;
+    balance: string;
+    networkName: string;
+}
+/**
+ * Blockchain Token Minter for ZIP files
+ */
+export declare class ZipKitMinter {
+    private provider;
+    private wallet;
+    private contract;
+    private merkleRoot;
+    private archiveName;
+    private networkConfig;
+    private debug;
+    constructor(archiveName: string, merkleRoot: string, options: MintingOptions);
+    /**
+     * Get wallet information
+     */
+    getWalletInfo(): Promise<WalletInfo>;
+    /**
+     * Check for existing tokens with same merkle root and verify ownership
+     */
+    checkForDuplicates(): Promise<DuplicateCheckResult>;
+    /**
+     * Estimate gas costs for minting
+     */
+    estimateGasCosts(): Promise<{
+        gasLimit: bigint;
+        gasPrice: bigint;
+        estimatedCost: string;
+    }>;
+    /**
+     * Create token metadata string
+     */
+    private createTokenMetadataString;
+    /**
+     * Create TokenMetadata object from minting result
+     */
+    private createTokenMetadata;
+    /**
+     * Mint new token on blockchain
+     */
+    mintToken(): Promise<MintingResult>;
+    /**
+     * Main minting process - checks for duplicates, then mints if needed
+     */
+    processMinting(): Promise<{
+        walletInfo: WalletInfo;
+        duplicateCheck: DuplicateCheckResult;
+        gasCosts?: {
+            gasLimit: bigint;
+            gasPrice: bigint;
+            estimatedCost: string;
+        };
+        mintingResult?: MintingResult;
+        tokenMetadata?: TokenMetadata;
+    }>;
+    /**
+     * Complete the minting after user confirmation
+     */
+    completeMinting(): Promise<{
+        mintingResult: MintingResult;
+        tokenMetadata?: TokenMetadata;
+    }>;
+}
+/**
+ * Utility function to validate Ethereum private key
+ */
+export declare function validatePrivateKey(privateKey: string): boolean;