Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# CLAUDE.md

## 📦 Project Summary

**go-subtree** is a high-performance Go library for managing Bitcoin SV (BSV) merkle tree subtree structures. It provides efficient tools for organizing transactions hierarchically, essential for block assembly, transaction validation, and merkle proof generation in BSV blockchain infrastructure.

### Core Capabilities
- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal
- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees
- **Serialization**: Binary format support for storage and transmission with streaming deserialization
- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts
- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation

### Target Use Cases
Bitcoin block construction, SPV proof generation, teranode transaction organization.

## 🤖 Welcome, Claude

This repository uses **`AGENTS.md`** as the single source of truth for:
Expand Down
42 changes: 33 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
# 🌿 go-subtree
> A Go library for efficiently managing Bitcoin SV Subtree transaction structures

## 📦 Overview

**go-subtree** is a high-performance Go library for managing Bitcoin SV (BSV) merkle tree subtree structures. It provides efficient tools for organizing transactions hierarchically, essential for block assembly, transaction validation, and merkle proof generation in BSV blockchain infrastructure.

### Core Capabilities
- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal
- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees
- **Serialization**: Binary format support for storage and transmission with streaming deserialization
- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts
- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation

### Target Use Cases
Bitcoin block construction, SPV proof generation, teranode transaction organization.

<br/>

<table>
<thead>
<tr>
Expand Down Expand Up @@ -75,15 +91,23 @@
<br/>

## 🗂️ Table of Contents
* [Installation](#-installation)
* [Documentation](#-documentation)
* [Examples & Tests](#-examples--tests)
* [Benchmarks](#-benchmarks)
* [Code Standards](#-code-standards)
* [AI Compliance](#-ai-compliance)
* [Maintainers](#-maintainers)
* [Contributing](#-contributing)
* [License](#-license)
- [🌿 go-subtree](#-go-subtree)
- [📦 Overview](#-overview)
- [Core Capabilities](#core-capabilities)
- [Target Use Cases](#target-use-cases)
- [🗂️ Table of Contents](#️-table-of-contents)
- [📦 Installation](#-installation)
- [📚 Documentation](#-documentation)
- [🎛️ The Workflow Control Center](#️-the-workflow-control-center)
- [🧪 Examples \& Tests](#-examples--tests)
- [⚡ Benchmarks](#-benchmarks)
- [Benchmark Results](#benchmark-results)
- [🛠️ Code Standards](#️-code-standards)
- [🤖 AI Compliance](#-ai-compliance)
- [👥 Maintainers](#-maintainers)
- [🤝 Contributing](#-contributing)
- [How can I help?](#how-can-i-help)
- [📝 License](#-license)

<br/>

Expand Down
Loading