Add some light docs, rm empty walletinterface (better as events)
authorMatt Corallo <git@bluematt.me>
Wed, 21 Feb 2018 04:16:26 +0000 (23:16 -0500)
committerMatt Corallo <git@bluematt.me>
Wed, 21 Feb 2018 14:49:21 +0000 (09:49 -0500)
src/chain/chaininterface.rs
src/lib.rs
src/wallet/mod.rs [deleted file]
src/wallet/walletinterface.rs [deleted file]

index ef8f9bf15525cba26685cb2da7823cf4ccd58982..ad298ce94db35eb4a29bec7c11fc884e6a8cf8af 100644 (file)
@@ -7,6 +7,9 @@ use std::sync::{Weak,Mutex};
 
 /// An interface to request notification of certain scripts as they appear the
 /// chain.
+/// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
+/// called from inside the library in response to ChainListener events, P2P events, or timer
+/// events).
 pub trait ChainWatchInterface: Sync + Send {
        /// Provides a scriptPubKey which much be watched for.
        fn install_watch_script(&self, script_pub_key: Script);
@@ -45,6 +48,11 @@ pub enum ConfirmationTarget {
        HighPriority,
 }
 
+/// A trait which should be implemented to provide feerate information on a number of time
+/// horizons.
+/// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
+/// called from inside the library in response to ChainListener events, P2P events, or timer
+/// events).
 pub trait FeeEstimator: Sync + Send {
        fn get_est_sat_per_vbyte(&self, ConfirmationTarget) -> u64;
 }
index 3d2b94d8690080cccb9cfab489c49b3e58c92a05..4a3ab27189da46f8ebac43eadbc8cf742ea082cf 100644 (file)
@@ -7,6 +7,5 @@ extern crate crypto;
 extern crate num; //TODO: Convince andrew to not rely on this for fucking casting...
 
 pub mod chain;
-pub mod wallet;
 pub mod ln;
 pub mod util;
diff --git a/src/wallet/mod.rs b/src/wallet/mod.rs
deleted file mode 100644 (file)
index 0759f54..0000000
+++ /dev/null
@@ -1 +0,0 @@
-pub mod walletinterface;
diff --git a/src/wallet/walletinterface.rs b/src/wallet/walletinterface.rs
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-