From: Matt Corallo <git@bluematt.me>
Date: Wed, 19 Sep 2018 19:01:26 +0000 (-0400)
Subject: Document ConfirmationTarget a little bit (closes #101)
X-Git-Tag: v0.0.12~304^2~1
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=7f6c31ea15ca0042da0dd50f9e0819065eb00757;p=rust-lightning

Document ConfirmationTarget a little bit (closes #101)
---

diff --git a/src/chain/chaininterface.rs b/src/chain/chaininterface.rs
index 5ff720c32..6f6362284 100644
--- 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,
 }