bolt5

commit ead7cd3dff620c87d31f68bd7eed91929cda213a
parent 3aab0abbd9add2eb3df508f3f3a142cae268318c
Author: Jared Tobin <jared@jtobin.io>
Date:   Sat, 18 Apr 2026 22:32:17 +0800

readme: add examples

Diffstat:
M
README.md
 | 
56
++++++++++++++++++++++++++++++++++++++++++++++++++++----

1 file changed, 52 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -1,21 +1,69 @@
 # ppad-bolt5
 
+[![](https://img.shields.io/hackage/v/ppad-bolt5?color=blue)](https://hackage.haskell.org/package/ppad-bolt5)
 ![](https://img.shields.io/badge/license-MIT-brightgreen)
+[![](https://img.shields.io/badge/haddock-bolt5-lightblue)](https://docs.ppad.tech/bolt5)
 
 A pure Haskell implementation of [BOLT #5][bolt5] (Lightning Network
 on-chain transaction handling), including logic for mutual close,
 unilateral close, and revoked transaction close scenarios.
 
+## Usage
+
+A sample GHCi session:
+
+```
+  > :set -XOverloadedStrings
+  >
+  > import qualified Data.ByteString as BS
+  > import qualified Lightning.Protocol.BOLT3 as BOLT3
+  > import qualified Lightning.Protocol.BOLT5 as BOLT5
+  >
+  > -- fee calculation using BOLT #5 Appendix A weight constants
+  > let feerate = BOLT3.FeeratePerKw 5000
+  > BOLT5.spending_fee feerate BOLT5.to_local_penalty_input_weight
+  Satoshi 1620
+  > BOLT5.spending_fee feerate BOLT5.penalty_tx_base_weight
+  Satoshi 1070
+  >
+  > -- check if an HTLC has timed out at the current block height
+  > let htlc = BOLT3.HTLC BOLT3.HTLCOffered (BOLT3.MilliSatoshi 50000000)
+  >              (BOLT3.PaymentHash (BS.replicate 32 0xAA))
+  >              (BOLT3.CltvExpiry 800000)
+  > BOLT5.htlc_timed_out 799999 htlc
+  False
+  > BOLT5.htlc_timed_out 800000 htlc
+  True
+  >
+  > -- extract a payment preimage from an offered HTLC witness
+  > let preimage = BS.replicate 32 0xBB
+  > let sig = BS.replicate 71 0xCC
+  > let wit = BOLT3.Witness [sig, preimage]
+  > BOLT5.extract_preimage_offered wit
+  Just PaymentPreimage <redacted>
+  >
+  > -- construct an unsigned spending tx for a to_local output
+  > let Just txid = BOLT3.mkTxId (BS.replicate 32 0x01)
+  > let outpoint = BOLT3.OutPoint txid 0
+  > let value = BOLT3.Satoshi 1000000
+  > let revpk = BOLT3.RevocationPubkey (BOLT3.Pubkey (BS.replicate 33 0x02))
+  > let delay = BOLT3.ToSelfDelay 144
+  > let delayedpk = BOLT3.LocalDelayedPubkey (BOLT3.Pubkey (BS.replicate 33 0x03))
+  > let dest = BOLT3.Script (BS.replicate 34 0x00)
+  >
+  > let stx = BOLT5.spend_to_local outpoint value revpk delay
+  >             delayedpk dest feerate
+  > BOLT5.stx_sighash_type stx
+  SIGHASH_ALL
+```
+
 ## Documentation
 
 Haddocks are hosted at [docs.ppad.tech/bolt5][hadoc].
 
 ## Security
 
-This library aims at the maximum security achievable in a
-garbage-collected language under an optimizing compiler such as GHC.
-If you discover any vulnerabilities, please disclose them via
-security@ppad.tech.
+This is a pre-release and makes no claims about security whatsoever.
 
 ## Development