chore: Reconcile shardeum to dev HEAD (#15)

Author: kgmyatthu

.github/workflows/ci.yml

@@ -10,8 +10,7 @@ on:
       - main
   pull_request:
     branches:
-      - dev
-      - main
+      - '**'
   issue_comment:
     inputs:
       workflowBranch:

.prettierignore

@@ -0,0 +1,5 @@
+build
+node_modules
+dist
+target
+bin

CLAUDE.md

@@ -0,0 +1,114 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+lib-net is a hybrid TypeScript/Rust networking library (`@shardeum-foundation/lib-net`) that provides TCP-based JSON message passing between nodes with request/response patterns. The library uses native Rust code for performance-critical networking operations while exposing a TypeScript API for Node.js applications.
+
+## Development Commands
+
+### Building
+```bash
+# Full build (Rust + TypeScript)
+npm run build
+
+# Build only TypeScript
+npm run build-node
+
+# Build only Rust (debug mode)
+npm run build-rust-debug
+
+# Build only Rust (release mode)
+npm run build-rust-release
+```
+
+### Testing
+```bash
+# Run all tests
+npm test
+
+# Run Rust tests
+npm run test:cargo
+# or
+cargo test
+
+# Run specific integration tests
+npm run it-test
+npm run it-test2
+```
+
+### Code Quality
+```bash
+# Run ESLint
+npm run lint
+
+# Check formatting
+npm run format-check
+
+# Fix formatting
+npm run format-fix
+```
+
+### Release Process
+```bash
+# Patch release (1.6.0 -> 1.6.1)
+npm run release:patch
+
+# Minor release (1.6.0 -> 1.7.0)
+npm run release:minor
+
+# Major release (1.6.0 -> 2.0.0)
+npm run release:major
+
+# Pre-release versions
+npm run release:prepatch
+npm run release:preminor
+npm run release:premajor
+npm run release:prerelease
+```
+
+## Architecture
+
+### Directory Structure
+- `src/`: TypeScript source code - API layer and Node.js bindings
+- `shardus_net/`: Main Rust crate implementing core networking functionality
+- `crypto/`: Rust crate for cryptographic operations (signing, verification)
+- `shardeum_utils/`: Shared Rust utilities
+- `test/`: Test files (unit tests in `test/unit/`, integration tests in root)
+- `build/`: TypeScript compilation output
+- `coverage/`: Test coverage reports
+
+### Key Components
+
+1. **TypeScript Layer** (`src/`)
+   - `index.ts`: Main entry point, exports the network creation function
+   - Handles Node.js integration and provides JavaScript-friendly API
+   - Manages correlation of requests/responses using UUIDs
+
+2. **Rust Layer** (`shardus_net/`)
+   - `lib.rs`: Main Rust library entry point
+   - Compiles to `shardus-net.node` native module
+   - Implements high-performance TCP socket handling
+   - Features compression (flate2, brotli) and LRU caching
+   - Uses Tokio for async runtime
+
+3. **Message Flow**
+   - Messages are JSON-serialized with UUID correlation IDs
+   - Supports request/response pattern with timeouts
+   - Can send to multiple nodes simultaneously
+   - Headers support compression options
+
+### Build Process
+1. Rust code compiles to a C dynamic library (`cdylib`)
+2. `cargo-cp-artifact` copies the compiled artifact to `shardus-net.node`
+3. TypeScript compiles to JavaScript in `build/` directory
+4. The `postinstall` script automatically builds Rust code when installing
+
+## Important Notes
+
+- **Node.js Version**: Requires exactly Node.js 18.19.1
+- **Main Branch**: Development happens on `dev` branch (not `main` or `master`)
+- **Native Module**: The Rust code compiles to a native Node.js module - platform-specific builds required
+- **Security**: Follow responsible disclosure per SECURITY.md for vulnerabilities
+- **Testing**: Always run both TypeScript and Rust tests before submitting changes

Cargo.lock

@@ -0,0 +1,60 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you believe you’ve found a security vulnerability in this project, we strongly encourage responsible disclosure and will work with you to resolve the issue promptly.
+
+Please **do not** create a public issue or discuss the vulnerability in public forums.
+
+### 🔒 Preferred Methods of Disclosure
+
+You have two options to report security issues:
+
+1. **Private Disclosure via GitHub (Recommended)**
+
+   - Use the **"Report a vulnerability"** button in the GitHub repository's **/security/advisories** page.
+   - This will privately notify the maintainers through GitHub’s security advisory workflow.
+
+2. **Email**
+   - Send a detailed report to: **security at shardeum dot org**
+
+### What to Include
+
+To help us understand and resolve the issue quickly, please include (where possible):
+
+- A detailed description of the vulnerability
+- Steps to reproduce it
+- Any relevant proof-of-concept code
+- The potential impact or affected components
+
+### What to Expect
+
+- We will acknowledge your report within **3 business days**.
+- We will investigate and confirm the issue.
+- If a fix is needed, we’ll prepare a patch and may issue a **GitHub Security Advisory** (and CVE if applicable).
+- We’ll keep you informed throughout the process and credit you if appropriate.
+
+We appreciate your efforts in keeping our project and its users safe.
+
+### Responsible Disclosure Guidelines
+
+When conducting security research and reporting vulnerabilities, we request that you:
+
+- Make every effort to avoid privacy violations, degradation of user experience, disruption to production systems, and destruction or manipulation of data.
+- Only interact with accounts or data that you own or have explicit permission to access.
+- Limit the amount of data you access or download to the minimum necessary to demonstrate the vulnerability.
+- Do not use a vulnerability to gain persistent access to systems or exfiltrate sensitive information.
+- Report the vulnerability to us as soon as you discover it.
+- Allow us a reasonable timeframe to investigate, fix, and announce the vulnerability before making it public.
+
+## Supported Versions
+
+We only provide security updates for the **latest stable release**. Make sure you're up-to-date.
+
+### 🛡️ Safe Harbor
+
+We consider security research conducted in accordance with this policy to be authorized. If you make a good faith effort to discover and report vulnerabilities by following these guidelines, we will not initiate legal action against you or ask law enforcement to investigate you. If any third party initiates legal action against you related to research conducted under this policy, we will make it known that your actions were authorized by us.
+
+---
+
+Thank you for helping improve the security of this project!

SECURITY.md

@@ -92,6 +92,15 @@ impl ShardusCrypto {
         }
     }
 
+    pub fn hashslice(&self, input: &[u8], fmt: Format) -> HexStringOrBuffer {
+        let digest = sodiumoxide::crypto::generichash::hash(input, Some(32), Some(&self.hash_key)).expect("Cannot digest input");
+
+        match fmt {
+            Format::Hex => HexStringOrBuffer::Hex(sodiumoxide::hex::encode(&digest)),
+            Format::Buffer => HexStringOrBuffer::Buffer(digest.as_ref().to_vec()),
+        }
+    }
+
     /// Signs the input data using the provided secret key.
     ///
     /// # Arguments

crypto/src/lib.rs

@@ -2,14 +2,10 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  roots: [
-    "<rootDir>/test/unit"
-  ],
-  testMatch: [
-    "**/__tests__/**/*.+(ts|tsx|js)",
-    "**/?(*.)+(spec|test).+(ts|tsx|js)"
-  ],
+  roots: ['<rootDir>/test/unit'],
+  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
   transform: {
-    "^.+\\.(ts|tsx)$": "ts-jest"
+    '^.+\\.(ts|tsx)$': 'ts-jest',
   },
-};
+  setupFiles: ['<rootDir>/test/jest.setup.js'],
+}