Document ConfirmationTarget a little bit (closes #101)

[rust-lightning] / src / chain / chaininterface.rs

diff --git a/src/chain/chaininterface.rs b/src/chain/chaininterface.rs
index 5ff720c32e5fed57d8c0ad23e20c3180c675674e..6f6362284072958115e97d5fe585d4e93e96e2ec 100644 (file)
--- a/src/chain/chaininterface.rs
+++ b/src/chain/chaininterface.rs
@@ -70,9 +70,14 @@ pub trait ChainListener: Sync + Send {
        fn block_disconnected(&self, header: &BlockHeader);
 }
 
+/// An enum that represents the speed at which we want a transaction to confirm used for feerate
+/// estimation.
 pub enum ConfirmationTarget {
+       /// We are happy with this transaction confirming slowly when feerate drops some.
        Background,
+       /// We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
        Normal,
+       /// We'd like this transaction to confirm in the next few blocks.
        HighPriority,
 }