commit 19c3972a136c164219c357c00ee359480fa8f01c parent 90533d227b2bad3d44051fd709854651082266da Author: Jared Tobin <jared@jtobin.io> Date: Sun, 25 Jan 2026 10:55:30 +0400 doc: add framing section to module header Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Diffstat:
| M | lib/Lightning/Protocol/BOLT8.hs | | | 7 | +++++++ |
1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/lib/Lightning/Protocol/BOLT8.hs b/lib/Lightning/Protocol/BOLT8.hs @@ -57,6 +57,13 @@ -- (plaintext, session') <- 'decrypt' session ciphertext -- @ -- +-- = Message Framing +-- +-- BOLT #8 runs over a byte stream, so callers often need to deal with +-- partial buffers. Use 'decrypt_frame' when you have exactly one frame, +-- or 'decrypt_frame_partial' to handle incremental reads and return how +-- many bytes are still needed. +-- -- Maximum plaintext size is 65535 bytes. module Lightning.Protocol.BOLT8 (