[#IsDust]
= IsDust
:mrdocs:

Test whether an output is dust at the given relay fee rate.

== Synopsis

Declared in `<policy/policy.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
IsDust(
    xref:CTxOut.adoc[CTxOut] const& txout,
    xref:CFeeRate.adoc[CFeeRate] const& dustRelayFee);
----

== Return Value

`true` if the output is below the dust threshold.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *txout*
| Output to test.
| *dustRelayFee*
| Fee rate used to define dust.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#