@dignetwork/chia-block-listener 0.1.4 → 0.1.6

package/.github/workflows/CI.yml

@@ -75,14 +75,14 @@ jobs:
               set -e &&
               export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER=aarch64-linux-gnu-gcc &&
               npm run build -- --target aarch64-unknown-linux-gnu
-    name: stable - ${{ matrix.settings.target }} - node@20
+    name: stable - ${{ matrix.settings.target }} - node@22
     runs-on: ${{ matrix.settings.host }}
     steps:
       - uses: actions/checkout@v4
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           cache: npm
       - name: Install
         uses: dtolnay/rust-toolchain@stable
@@ -113,7 +113,7 @@ jobs:
         uses: actions/setup-node@v4
         if: matrix.settings.target == 'i686-pc-windows-msvc'
         with:
-          node-version: 20
+          node-version: 22
           cache: npm
           architecture: x86
       - name: Setup toolchain
@@ -123,6 +123,18 @@ jobs:
       - name: Build
         run: ${{ matrix.settings.build }}
         shell: bash
+      - name: List files after build
+        run: |
+          echo "=== Current directory contents ==="
+          ls -la
+          echo "=== Looking for .node files ==="
+          find . -name "*.node" -type f
+          echo "=== Looking for files matching pattern ==="
+          ls -la ${{ env.APP_NAME }}.*.node || echo "No files match the pattern"
+          echo "=== Environment variables ==="
+          echo "APP_NAME: ${{ env.APP_NAME }}"
+          echo "Target: ${{ matrix.settings.target }}"
+        shell: bash
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
@@ -130,128 +142,141 @@ jobs:
           path: ${{ env.APP_NAME }}.*.node
           if-no-files-found: error
 
-  # TODO: Re-enable tests after builds are working
-  # test-macOS-windows-binding:
-  #   name: Test bindings on ${{ matrix.settings.target }} - node@${{ matrix.node }}
-  #   needs:
-  #     - build
-  #   strategy:
-  #     fail-fast: false
-  #     matrix:
-  #       settings:
-  #         - host: macos-latest
-  #           target: x86_64-apple-darwin
-  #         - host: windows-latest
-  #           target: x86_64-pc-windows-msvc
-  #       node:
-  #         - '18'
-  #         - '20'
-  #   runs-on: ${{ matrix.settings.host }}
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Setup node
-  #       uses: actions/setup-node@v4
-  #       with:
-  #         node-version: ${{ matrix.node }}
-  #         cache: npm
-  #         architecture: x64
-  #     - name: Install dependencies
-  #       run: npm ci
-  #     - name: Download artifacts
-  #       uses: actions/download-artifact@v4
-  #       with:
-  #         name: bindings-${{ matrix.settings.target }}
-  #         path: .
-  #     - name: List packages
-  #       run: ls -R .
-  #       shell: bash
-  #     - name: Test bindings
-  #       run: npm test
+  test-macOS-windows-binding:
+    name: Test bindings on ${{ matrix.settings.target }} - node@${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - host: macos-latest
+            target: x86_64-apple-darwin
+          - host: windows-latest
+            target: x86_64-pc-windows-msvc
+        node:
+          - '20'
+          - '22'
+    runs-on: ${{ matrix.settings.host }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: npm
+          architecture: x64
+      - name: Install dependencies
+        run: npm ci
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-${{ matrix.settings.target }}
+          path: .
+      - name: Move artifacts
+        run: npm run artifacts
+      - name: List packages
+        run: ls -R .
+        shell: bash
+      - name: Test bindings
+        run: npm test
 
-  # test-linux-x64-gnu-binding:
-  #   name: Test bindings on Linux-x64-gnu - node@${{ matrix.node }}
-  #   needs:
-  #     - build
-  #   strategy:
-  #     fail-fast: false
-  #     matrix:
-  #       node:
-  #         - '18'
-  #         - '20'
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Setup node
-  #       uses: actions/setup-node@v4
-  #       with:
-  #         node-version: ${{ matrix.node }}
-  #         cache: npm
-  #     - name: Install dependencies
-  #       run: npm ci
-  #     - name: Download artifacts
-  #       uses: actions/download-artifact@v4
-  #       with:
-  #         name: bindings-x86_64-unknown-linux-gnu
-  #         path: .
-  #     - name: List packages
-  #       run: ls -R .
-  #       shell: bash
-  #     - name: Test bindings
-  #       run: docker run --rm -v $(pwd):/build -w /build node:${{ matrix.node }}-slim npm test
+  test-linux-x64-gnu-binding:
+    name: Test bindings on Linux-x64-gnu - node@${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node:
+          - '20'
+          - '22'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-x86_64-unknown-linux-gnu
+          path: .
+      - name: Install dependencies
+        run: npm ci
+      - name: Move artifacts
+        run: npm run artifacts
+      - name: List packages
+        run: ls -R .
+        shell: bash
+      - name: Test bindings
+        run: npm test
 
-  # test-linux-aarch64-gnu-binding:
-  #   name: Test bindings on aarch64-unknown-linux-gnu - node@${{ matrix.node }}
-  #   needs:
-  #     - build
-  #   strategy:
-  #     fail-fast: false
-  #     matrix:
-  #       node:
-  #         - '18'
-  #         - '20'
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - name: Download artifacts
-  #       uses: actions/download-artifact@v4
-  #       with:
-  #         name: bindings-aarch64-unknown-linux-gnu
-  #         path: .
-  #     - name: List packages
-  #       run: ls -R .
-  #       shell: bash
-  #     - name: Install dependencies
-  #       run: npm ci
-  #     - name: Set up QEMU
-  #       uses: docker/setup-qemu-action@v3
-  #       with:
-  #         platforms: arm64
-  #     - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
-  #     - name: Setup and run tests
-  #       uses: addnab/docker-run-action@v3
-  #       with:
-  #         image: node:${{ matrix.node }}-slim
-  #         options: '--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build'
-  #         run: |
-  #           set -e
-  #           npm test
-  #           ls -la
+  test-linux-aarch64-gnu-binding:
+    name: Test bindings on aarch64-unknown-linux-gnu - node@${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node:
+          - '20'
+          - '22'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-aarch64-unknown-linux-gnu
+          path: .
+      - name: Install dependencies
+        run: npm ci
+      - name: Move artifacts
+        run: npm run artifacts
+      - name: List packages
+        run: ls -R .
+        shell: bash
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
+      - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+      - name: Setup and run tests
+        uses: addnab/docker-run-action@v3
+        with:
+          image: ubuntu:24.04
+          options: '--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build'
+          run: |
+            set -e
+            apt-get update
+            apt-get install -y curl
+            curl -fsSL https://deb.nodesource.com/setup_${{ matrix.node }}.x | bash -
+            apt-get install -y nodejs
+            node --version
+            npm --version
+            npm ci
+            npm test
+            ls -la
 
   publish:
     name: Publish
     runs-on: ubuntu-latest
     needs:
       - build
-      # TODO: Re-enable test dependencies after tests are working
-      # - test-macOS-windows-binding
-      # - test-linux-x64-gnu-binding
-      # - test-linux-aarch64-gnu-binding
+      - test-macOS-windows-binding
+      - test-linux-x64-gnu-binding
+      - test-linux-aarch64-gnu-binding
     steps:
       - uses: actions/checkout@v4
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           cache: npm
       - name: Install dependencies
         run: npm ci

package/.knowledge/context.md

@@ -0,0 +1,48 @@
+# Chia Block Listener Project Context
+
+## Current State
+- Rust-based WebSocket client connecting to Chia full nodes
+- Uses NAPI for Node.js bindings
+- Integrated chia-generator-parser crate for block parsing
+- Can monitor real-time blocks but coin_spends extraction not working
+
+## Architecture
+- `src/peer.rs`: WebSocket connection and block handling
+- `src/event_emitter.rs`: NAPI bindings and JS event system
+- `crate/chia-generator-parser/`: Block parsing using chia-protocol types
+- Direct integration with chia-protocol crate (v0.26.0)
+
+## Recent Progress
+- Successfully refactored to use chia-protocol types directly
+- Eliminated manual byte parsing and redundant serialization
+- Built and tested with real network connections
+- Created real-time block monitor (coin-monitor.js)
+- **FIXED: Implemented full CLVM execution using chia-consensus**
+- **FIXED: TypeScript definitions now include all event types**
+
+## Completed Implementations
+- Full CLVM execution using run_block_generator2 for coin extraction
+- Real puzzle reveals and solutions from generator bytecode
+- Proper TypeScript event type definitions with constants
+- Event interfaces for PeerConnected, PeerDisconnected, BlockReceived
+- Removed generatorBytecode from block events (not needed)
+- Log file streaming for coin-monitor.js
+- Removed processTransactionGenerator method (replaced by chia-generator-parser)
+- Changed peer IDs from numeric to IP:port strings for better identification
+- Added typed event emitters with full TypeScript support via post-build script
+- Removed redundant Block type - all APIs now use BlockReceivedEvent consistently
+
+## Dependencies
+- chia-protocol = "0.26.0"
+- chia-traits = "0.26.0"  
+- chia-ssl = "0.26.0"
+- chia-consensus = "0.26.0" (for CLVM execution)
+- chia-bls = "0.26.0" (for signature handling)
+- clvmr = "0.8.0" (for low-level CLVM operations)
+- clvm-utils = "0.26.0" (for tree hashing)
+- hex = "0.4" (for hex encoding/decoding)
+
+## Testing
+- example-get-block-by-height.js: Requests specific blocks
+- coin-monitor.js: Monitors real-time blocks
+- Both show generator_bytecode but empty coin_spends 

package/.knowledge/critical_missing_implementation.md

@@ -0,0 +1,90 @@
+# Critical Missing Implementation: process_generator_for_coins
+
+## Current State ❌
+The `process_generator_for_coins` function in `parser.rs` uses placeholder pattern matching instead of proper CLVM execution.
+
+## Required Implementation
+
+### 1. Add chia_rs dependency
+```toml
+chia_rs = "0.11.0"  # or appropriate version
+```
+
+### 2. Use run_block_generator2
+```rust
+use chia_rs::{run_block_generator2, SpendBundleConditions};
+
+fn process_generator_for_coins(
+    &self, 
+    generator_bytes: &[u8],
+    block_refs: &[u32],  // generator references
+    max_cost: u64,
+    height: u32,
+) -> Result<(Vec<CoinInfo>, Vec<CoinSpendInfo>, Vec<CoinInfo>)> {
+    // Call run_block_generator2 to execute the generator
+    let (err, conds) = run_block_generator2(
+        generator_bytes,
+        block_refs,
+        max_cost,
+        flags,
+        None,  // aggregated_signature
+        None,  // bls_cache
+        &constants,
+    );
+    
+    if let Some(error) = err {
+        return Err(GeneratorParserError::GeneratorError(error));
+    }
+    
+    let conditions = conds.ok_or(GeneratorParserError::NoConditions)?;
+    
+    // Extract coins from SpendBundleConditions
+    let mut coin_removals = Vec::new();
+    let mut coin_additions = Vec::new();
+    let mut coin_spends = Vec::new();
+    
+    // Process each spend
+    for spend in conditions.spends {
+        // Each spend removes the coin being spent
+        coin_removals.push(CoinInfo::from(spend.coin));
+        
+        // Process CREATE_COIN conditions (opcode 51)
+        for condition in spend.conditions {
+            if condition.opcode == 51 {  // CREATE_COIN
+                let new_coin = Coin::new(
+                    spend.coin.coin_id(),  // parent
+                    condition.puzzle_hash,
+                    condition.amount,
+                );
+                coin_additions.push(CoinInfo::from(new_coin));
+            }
+        }
+        
+        // Build coin spend info
+        coin_spends.push(CoinSpendInfo {
+            coin: spend.coin,
+            puzzle_reveal: spend.puzzle_reveal,
+            solution: spend.solution,
+            // ... other fields
+        });
+    }
+    
+    Ok((coin_removals, coin_spends, coin_additions))
+}
+```
+
+### 3. Key Points
+- SpendBundleConditions contains all spends from the generator
+- Each spend has:
+  - The coin being spent (removal)
+  - Conditions including CREATE_COIN (additions)
+  - Puzzle reveal and solution
+- Must handle generator references for compressed blocks
+- Must pass proper constants and flags
+
+### 4. Missing Dependencies
+Without proper CLVM execution via run_block_generator2:
+- Cannot extract accurate coin data
+- Cannot validate transactions
+- Cannot build functional block explorers or wallets
+- Will report incorrect blockchain state 

package/.knowledge/gaps.md

@@ -0,0 +1,22 @@
+# Known Implementation Gaps
+
+## Critical CLVM Execution Gap (PARTIALLY ADDRESSED)
+- **Issue**: Using pattern matching instead of proper CLVM execution
+- **Current**: Pattern matching extracts puzzle reveals and solutions from bytecode
+- **Missing**: Cannot extract CREATE_COIN conditions or handle block references
+- **Impact**: Will miss coins created by transactions and compressed blocks
+- **Required**: Full integration with chia-consensus run_block_generator2
+- **Blocker**: chia-consensus module paths not publicly exposed
+- **Status**: Documented with workaround implemented
+
+## Compressed Block References (UNRESOLVED)
+- **Issue**: Cannot handle blocks that reference previous generators
+- **Impact**: Many blocks will fail to parse completely
+- **Required**: Generator reference resolution system
+- **Status**: Placeholder returns empty results
+
+## Real-time Block Coin Spend Extraction (RESOLVED)
+- **Issue**: coin_spends array is empty even when generator_bytecode is present
+- **Resolution**: parse_block() now calls process_generator_for_coins
+- **Current**: Pattern matching extracts basic coin spends
+- **Limitation**: Missing CREATE_COIN conditions 

package/.knowledge/implementation_audit.md

@@ -0,0 +1,98 @@
+# Implementation Audit: chia-generator-parser vs Python full_node
+
+## Executive Summary
+
+After comparing the Rust implementation with the Python full_node code, there are **3 critical issues** and **1 minor issue** that prevent this from being production-ready.
+
+## Critical Issues
+
+### 1. ❌ Generator Execution Not Implemented (`process_generator_for_coins`)
+**Location**: `crate/chia-generator-parser/src/parser.rs:296-365`
+**Issue**: Uses placeholder pattern matching instead of proper CLVM execution
+**Required**: Must use `run_block_generator2` from chia_rs to:
+- Execute the generator with proper block references
+- Extract SpendBundleConditions
+- Get accurate coin removals, additions, and spends
+
+**Python Reference**: `mempool.py:539`
+```python
+err, conds = run_block_generator2(
+    block_program,
+    [],  # generator refs
+    constants.MAX_BLOCK_COST_CLVM,
+    flags,
+    spend_bundle.aggregated_signature,
+    None,
+    constants,
+)
+```
+
+### 2. ❌ No Coin Spend Details Extraction
+**Issue**: Current implementation cannot extract:
+- Puzzle reveals for each spend
+- Solutions for each spend
+- Accurate parent-child relationships
+- Conditions from each spend
+
+**Required**: After running generator, need to parse SpendBundleConditions to extract:
+- Individual coin spends with full data
+- CREATE_COIN conditions (opcode 51) for coin additions
+- All spent coins for removals
+
+### 3. ❌ No Generator Reference Support
+**Issue**: Blocks can reference previous generators to save space
+**Current**: Generator refs are parsed but not used
+**Required**: When executing generator, must provide referenced generators from previous blocks
+
+## Minor Issue
+
+### 4. ⚠️ Header Block Creation Incomplete (`header_block_from_block`)
+**Location**: `crate/chia-generator-parser/src/parser.rs:653-668`
+**Issue**: Returns original block instead of creating proper header
+**Required**: 
+- Extract fields up to (but not including) transactions_info
+- Create BIP158 filter if requested
+- Serialize with filter + optional transactions_info
+
+**Note**: This is less critical as it's mainly for network protocol optimization
+
+## Implemented Correctly ✅
+
+1. **Block Parsing**: All skip functions correctly match Python
+2. **Field Extraction**: Height, weight, timestamp, reward claims all correct
+3. **Generator Extraction**: `extract_generator_from_block` matches Python exactly
+4. **Block Info**: `parse_block_info` correctly extracts GeneratorBlockInfo
+5. **Height/TX Status**: `get_height_and_tx_status_from_block` correct
+
+## Production Readiness Assessment
+
+**Current State**: NOT production ready
+**Reason**: Cannot accurately extract coins from blocks with generators
+
+### Required for Production:
+
+1. **Add chia_rs dependency** or implement custom `run_block_generator2`
+2. **Implement proper generator execution** with:
+   - Block reference loading
+   - Consensus constants
+   - Proper flags (MEMPOOL_MODE, etc.)
+3. **Parse SpendBundleConditions** to extract:
+   - Coin removals (spent coins)
+   - Coin additions (from CREATE_COIN)
+   - Full spend details
+4. **Handle generator references** for compressed blocks
+
+### Optional Improvements:
+
+1. Complete `header_block_from_block` for protocol compatibility
+2. Add signature validation support
+3. Add cost tracking and limits
+
+## Recommendation
+
+The block parsing infrastructure is solid, but without proper CLVM execution, this cannot be used in production. The current pattern matching approach will:
+- Miss most coins
+- Report incorrect coin data
+- Fail on compressed generators with references
+
+**Action**: Either integrate chia_rs properly or implement a custom CLVM executor before production use. 

package/.knowledge/incomplete.md

@@ -0,0 +1,32 @@
+# Incomplete Implementations
+
+## ~~CLVM Transaction Generator Parsing~~ ✅ FIXED
+- **File**: `src/event_emitter.rs`
+- **Function**: `execute_transaction_generator`
+- **Lines**: ~1030-1080
+- **Type**: ~~Incorrect implementation~~ ✅ FIXED
+- **Issue**: ~~Using wrong parsing approach, should use `node_from_bytes`~~ ✅ FIXED
+- **Priority**: ~~High~~ ✅ COMPLETED
+- **Solution Applied**: Now uses `clvmr::serde::node_from_bytes` and proper CLVM execution
+
+## Code Cleanup Needed
+- **File**: `src/event_emitter.rs`
+- **Functions**: Multiple unused fallback parsing methods
+- **Lines**: Various (1384+, 1999+, etc.)
+- **Type**: Dead code after successful fix
+- **Issue**: Unused pattern matching and alternative parsing methods
+- **Priority**: Low (cleanup)
+
+## Unused Imports
+- **File**: `src/event_emitter.rs`
+- **Lines**: Various import statements
+- **Type**: Unused imports causing build warnings
+- **Issue**: 19 warning messages about unused imports
+- **Priority**: Low (cleanup)
+
+## Testing and Validation
+- **File**: `examples/coin-monitor.js`
+- **Function**: Real-world testing of CLVM parsing
+- **Type**: Validation needed
+- **Issue**: Need to confirm the fix works with actual transaction generators
+- **Priority**: Medium (validation) 

package/.knowledge/proj_index.md

@@ -0,0 +1,58 @@
+# Project Architecture Index
+
+## Module Structure
+
+### Core Components
+- `src/event_emitter.rs` - Main NAPI interface and event system
+  - ChiaBlockListener class
+  - Event handling (on/off methods)
+  - Peer management (addPeer, disconnectPeer, etc.)
+  - Block retrieval APIs
+
+- `src/peer.rs` - WebSocket peer connection management
+  - Connection handling
+  - Block listening
+  - Handshake protocol
+
+- `src/protocol.rs` - Chia protocol implementation
+  - Message types
+  - Handshake structures
+
+### Parser Module (`crate/chia-generator-parser/`)
+- `src/parser.rs` - Block parsing with CLVM execution
+  - Uses chia-consensus for generator execution
+  - Extracts coin spends with puzzle reveals/solutions
+  - Handles CREATE_COIN conditions
+
+### TypeScript Integration
+- `index.d.ts` - Auto-generated TypeScript definitions
+  - Enhanced with typed event overloads via post-build script
+  - Full IntelliSense support for event handlers
+
+- `scripts/post-build.js` - Adds typed event method overloads
+  - Runs automatically after build
+  - Provides type-safe event handling
+
+## Key Interfaces
+
+### Events
+- `BlockReceivedEvent` - Contains peerId + all block data
+- `PeerConnectedEvent` - peerId, host, port
+- `PeerDisconnectedEvent` - peerId, host, port, optional message
+
+### Data Types  
+- `BlockReceivedEvent` - Used everywhere for consistency (includes peerId)
+- `CoinRecord` - Parent info, puzzle hash, amount
+- `CoinSpend` - Full spend with puzzle reveal and solution
+
+## Event System
+```typescript
+// Typed event handlers
+listener.on('blockReceived', (event: BlockReceivedEvent) => { });
+listener.on('peerConnected', (event: PeerConnectedEvent) => { });
+listener.on('peerDisconnected', (event: PeerDisconnectedEvent) => { });
+```
+
+## Peer Identification
+- Peer IDs are now `"IP:port"` strings (e.g., `"192.168.1.100:8444"`)
+- Makes peer identification clearer in logs and events