Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,158 @@
+---
+license: mit
+task_categories:
+- other
+tags:
+- blockchain
+- commitments
+- np-complete
+- proof-of-work
+- coinjecture
+dataset_info:
+  features:
+    - name: commitment_id
+      dtype: string
+      description: Unique identifier for the commitment
+    - name: block_height
+      dtype: int64
+      description: Blockchain height where commitment was created
+    - name: commitment_hash
+      dtype: string
+      description: Hash of the commitment (H(problem_params || salt || H(solution)))
+    - name: problem_type
+      dtype: string
+      description: Type of NP-complete problem (SAT, TSP, SubsetSum, etc.)
+    - name: problem_params
+      dtype: string
+      description: JSON-encoded problem parameters
+    - name: salt
+      dtype: string
+      description: Random salt used in commitment
+    - name: solution_hash
+      dtype: string
+      description: Hash of the solution (H(solution))
+    - name: reveal_height
+      dtype: int64
+      description: Block height where solution was revealed (null if not yet revealed)
+    - name: solution_data
+      dtype: string
+      description: JSON-encoded solution data (null until reveal)
+    - name: work_score
+      dtype: float64
+      description: Computed work score for the commitment
+    - name: timestamp
+      dtype: int64
+      description: Unix timestamp when commitment was created
+    - name: miner_address
+      dtype: string
+      description: Address of the miner who created the commitment
+    - name: status
+      dtype: string
+      description: Status (Committed, Revealed, Expired)
+  splits:
+    - name: train
+      num_bytes: 0
+      num_examples: 0
+---
+
+# COINjecture Commitments Dataset
+
+This dataset contains cryptographic commitments from COINjecture Network B blockchain mining operations.
+
+## Overview
+
+Commitments are created during the mining process where miners commit to NP-complete problem solutions without revealing them immediately. This enables:
+- **Fair mining**: Prevents front-running and solution stealing
+- **Verifiable work**: Solutions can be verified after commitment
+- **Research data**: Provides structured data for NP-complete problem research
+
+## Dataset Structure
+
+Based on the baseline dataset `COINjecture/v5`, this dataset focuses specifically on commitment records.
+
+### Commitment Lifecycle
+
+1. **Commitment Phase**: Miner creates commitment hash = H(problem_params || salt || H(solution))
+2. **Reveal Phase**: Miner reveals solution after block is mined
+3. **Verification**: Network verifies commitment matches revealed solution
+
+### Schema
+
+Each record contains:
+- `commitment_id`: Unique identifier
+- `commitment_hash`: Cryptographic hash of the commitment
+- `problem_type`: Type of NP-complete problem
+- `problem_params`: Problem parameters (JSON)
+- `salt`: Random salt for commitment
+- `solution_hash`: Hash of solution (H(solution))
+- `solution_data`: Actual solution (revealed later, null initially)
+- `work_score`: Computed work score
+- `status`: Current status (Committed, Revealed, Expired)
+
+## Usage
+
+### Loading the Dataset
+
+```python
+from datasets import load_dataset
+
+# Load commitments dataset
+dataset = load_dataset("COINjecture/commitments")
+
+# Filter by status
+committed = dataset.filter(lambda x: x["status"] == "Committed")
+revealed = dataset.filter(lambda x: x["status"] == "Revealed")
+
+# Filter by problem type
+sat_commitments = dataset.filter(lambda x: x["problem_type"] == "SAT")
+```
+
+### Analyzing Commitments
+
+```python
+# Count commitments by status
+status_counts = dataset["train"].to_pandas()["status"].value_counts()
+
+# Average work scores by problem type
+avg_scores = dataset["train"].to_pandas().groupby("problem_type")["work_score"].mean()
+```
+
+## Data Collection
+
+Data is collected in real-time from COINjecture Network B blockchain nodes:
+- Commitments are recorded when blocks are mined
+- Solutions are revealed in subsequent blocks
+- All data is verified against blockchain state
+
+## Baseline Dataset
+
+This dataset is based on `COINjecture/v5` which contains:
+- Full problem solutions
+- Energy measurements
+- Mining metrics
+- Block metadata
+
+The commitments dataset focuses specifically on the commitment/reveal mechanism.
+
+## License
+
+MIT License - See LICENSE file for details.
+
+## Citation
+
+```bibtex
+@dataset{coinjecture_commitments,
+  title={COINjecture Commitments Dataset},
+  author={COINjecture Network},
+  year={2025},
+  url={https://huggingface.co/datasets/COINjecture/commitments}
+}
+```
+
+## Contact
+
+For issues or questions, please open an issue on the [COINjecture GitHub repository](https://github.com/Quigles1337/COINjecture1337-NETB).
+
+---
+
+**Generated automatically by COINjecture Network B blockchain nodes**