commit 7a03f2d2ca66e6ed1f304b698ed8baaa423c602d
parent 3ede0beb72812d79769878d1ab20978b6c563cb6
Author: Jared Tobin <jared@jtobin.io>
Date: Sat, 10 Oct 2026 15:26:26 +0400
meta: version 0.1.0, update CLAUDE.md and AGENTS.md
Diffstat:
3 files changed, 24 insertions(+), 10 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
@@ -4,13 +4,19 @@ Haskell implementation of BOLT #5 (Lightning Network on-chain transaction
handling).
Specification: https://github.com/lightning/bolts/blob/master/05-onchain.md
+(tracked as of lightning/bolts@1aadb719; copy in `etc/05-onchain.md`).
+
+The library's scope is being redesigned and it is not yet ready for
+release; see the README for what it does and doesn't cover.
## Project Structure
-- `lib/` - library source (Lightning.Protocol.BOLT5)
-- `test/` - tests (tasty + tasty-hunit)
+- `lib/` - library source (public API: Lightning.Protocol.BOLT5;
+ submodules are internal)
+- `test/` - tests (tasty, tasty-hunit, tasty-quickcheck), public API only;
+ BOLT #3 Appendix C/F vectors inline
- `bench/` - benchmarks (criterion for timing, weigh for allocations)
-- `etc/` - reference materials (BOLT spec)
+- `etc/` - reference materials (BOLT spec, pinned upstream commit)
- `flake.nix` - nix flake for dependency and build management
- `ppad-bolt5.cabal` - cabal package definition
- `CLAUDE.md` / `AGENTS.md` - keep these in sync
@@ -45,6 +51,8 @@ Use only minimal external dependencies. Prefer GHC's core/boot libraries
- Test dependencies (tasty, QuickCheck, etc. for test-suite only)
- Benchmark dependencies (criterion, weigh for benchmark only)
+Current dependencies: ppad-bolt1, ppad-bolt3, ppad-sha256, ppad-tx.
+
## Code Style
### Performance
@@ -140,5 +148,4 @@ When planning work:
The flake.nix follows ppad conventions:
- Uses ppad-nixpkgs as base
- Follows references to avoid duplication
-- Supports LLVM backend via cabal flag
- Provides devShell with ghc, cabal, cc, llvm
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -4,13 +4,19 @@ Haskell implementation of BOLT #5 (Lightning Network on-chain transaction
handling).
Specification: https://github.com/lightning/bolts/blob/master/05-onchain.md
+(tracked as of lightning/bolts@1aadb719; copy in `etc/05-onchain.md`).
+
+The library's scope is being redesigned and it is not yet ready for
+release; see the README for what it does and doesn't cover.
## Project Structure
-- `lib/` - library source (Lightning.Protocol.BOLT5)
-- `test/` - tests (tasty + tasty-hunit)
+- `lib/` - library source (public API: Lightning.Protocol.BOLT5;
+ submodules are internal)
+- `test/` - tests (tasty, tasty-hunit, tasty-quickcheck), public API only;
+ BOLT #3 Appendix C/F vectors inline
- `bench/` - benchmarks (criterion for timing, weigh for allocations)
-- `etc/` - reference materials (BOLT spec)
+- `etc/` - reference materials (BOLT spec, pinned upstream commit)
- `flake.nix` - nix flake for dependency and build management
- `ppad-bolt5.cabal` - cabal package definition
- `CLAUDE.md` / `AGENTS.md` - keep these in sync
@@ -45,6 +51,8 @@ Use only minimal external dependencies. Prefer GHC's core/boot libraries
- Test dependencies (tasty, QuickCheck, etc. for test-suite only)
- Benchmark dependencies (criterion, weigh for benchmark only)
+Current dependencies: ppad-bolt1, ppad-bolt3, ppad-sha256, ppad-tx.
+
## Code Style
### Performance
@@ -140,5 +148,4 @@ When planning work:
The flake.nix follows ppad conventions:
- Uses ppad-nixpkgs as base
- Follows references to avoid duplication
-- Supports LLVM backend via cabal flag
- Provides devShell with ghc, cabal, cc, llvm
diff --git a/ppad-bolt5.cabal b/ppad-bolt5.cabal
@@ -1,6 +1,6 @@
cabal-version: 3.0
name: ppad-bolt5
-version: 0.0.1
+version: 0.1.0
synopsis: On-chain transaction handling per BOLT #5
license: MIT
license-file: LICENSE
@@ -8,7 +8,7 @@ author: Jared Tobin
maintainer: jared@ppad.tech
category: Cryptography
build-type: Simple
-tested-with: GHC == 9.10.3
+tested-with: GHC == { 9.10.3 }
extra-doc-files: CHANGELOG
description:
On-chain transaction handling, per
