From: James Taylor <54148103+jatayl@users.noreply.github.com>
Date: Wed, 22 Dec 2021 06:50:17 +0000 (-0500)
Subject: add doc comment for IsDust trait
X-Git-Tag: v0.16.0~2^2~1
X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/struct.GeneratedKey.html?a=commitdiff_plain;h=a0c140bb29ab37103e4a24d296ac6fcea91da69e;p=bdk

add doc comment for IsDust trait
---

diff --git a/src/wallet/utils.rs b/src/wallet/utils.rs
index e9475232..8c7ee0ac 100644
--- a/src/wallet/utils.rs
+++ b/src/wallet/utils.rs
@@ -26,7 +26,9 @@ pub(crate) const SEQUENCE_LOCKTIME_MASK: u32 = 0x0000FFFF;
 // Threshold for nLockTime to be considered a block-height-based timelock rather than time-based
 pub(crate) const BLOCKS_TIMELOCK_THRESHOLD: u32 = 500000000;
 
-/// Trait to check if a value is below the dust limit
+/// Trait to check if a value is below the dust limit.
+/// We are performing dust value calculation for a given script public key using rust-bitcoin to
+/// keep it compatible with network dust rate
 // we implement this trait to make sure we don't mess up the comparison with off-by-one like a <
 // instead of a <= etc.
 pub trait IsDust {