Add doc to full_stack_target

[rust-lightning] / fuzz / fuzz_targets / full_stack_target.rs

diff --git a/fuzz/fuzz_targets/full_stack_target.rs b/fuzz/fuzz_targets/full_stack_target.rs
index 6274d8fcb70c6b6cb8c54a4aad4b133b32513495..5941e3c91f8e6d1a0847e64e82c933482fe0b15a 100644 (file)
--- a/fuzz/fuzz_targets/full_stack_target.rs
+++ b/fuzz/fuzz_targets/full_stack_target.rs
@@ -1,3 +1,9 @@
+//! Test that no series of bytes received over the wire/connections created/payments sent can
+//! result in a crash. We do this by standing up a node and then reading bytes from input to denote
+//! actions such as creating new inbound/outbound connections, bytes to be read from a connection,
+//! or payments to send/ways to handle events generated.
+//! This test has been very useful, though due to its complexity good starting inputs are critical.
+
 //Uncomment this for libfuzzer builds:
 //#![no_main]