Untitled Git - bitcoindevkit.org/blob

   1 <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Trait for generalized coin selection algorithms"><title>CoinSelectionAlgorithm in bdk_wallet::coin_selection - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bdk_wallet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../bdk_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bdk_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../bdk_wallet/index.html">bdk_wallet</a><span class="version">1.0.0-alpha.13</span></h2></div><h2 class="location"><a href="#">CoinSelectionAlgorithm</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.coin_select">coin_select</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bdk_wallet::coin_selection</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">bdk_wallet</a>::<wbr><a href="index.html">coin_selection</a>::<wbr><a class="trait" href="#">CoinSelectionAlgorithm</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/bdk_wallet/wallet/coin_selection.rs.html#216-238">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait CoinSelectionAlgorithm: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
   2     // Required method
   3     fn <a href="#tymethod.coin_select" class="fn">coin_select</a>(
   4         &amp;self,
   5         required_utxos: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../struct.WeightedUtxo.html" title="struct bdk_wallet::WeightedUtxo">WeightedUtxo</a>&gt;,
   6         optional_utxos: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../struct.WeightedUtxo.html" title="struct bdk_wallet::WeightedUtxo">WeightedUtxo</a>&gt;,
   7         fee_rate: FeeRate,
   8         target_amount: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
   9         drain_script: &amp;Script
  10     ) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.CoinSelectionResult.html" title="struct bdk_wallet::coin_selection::CoinSelectionResult">CoinSelectionResult</a>, <a class="enum" href="enum.Error.html" title="enum bdk_wallet::coin_selection::Error">Error</a>&gt;;
  11 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for generalized coin selection algorithms</p>
  12 <p>This trait can be implemented to make the <a href="../struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a> use a customized coin
  13 selection algorithm when it creates transactions.</p>
  14 <p>For an example see <a href="index.html" title="mod bdk_wallet::coin_selection">this module</a>’s documentation.</p>
  15 </div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.coin_select" class="method"><a class="src rightside" href="../../src/bdk_wallet/wallet/coin_selection.rs.html#230-237">source</a><h4 class="code-header">fn <a href="#tymethod.coin_select" class="fn">coin_select</a>(
  16     &amp;self,
  17     required_utxos: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../struct.WeightedUtxo.html" title="struct bdk_wallet::WeightedUtxo">WeightedUtxo</a>&gt;,
  18     optional_utxos: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../struct.WeightedUtxo.html" title="struct bdk_wallet::WeightedUtxo">WeightedUtxo</a>&gt;,
  19     fee_rate: FeeRate,
  20     target_amount: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
  21     drain_script: &amp;Script
  22 ) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.CoinSelectionResult.html" title="struct bdk_wallet::coin_selection::CoinSelectionResult">CoinSelectionResult</a>, <a class="enum" href="enum.Error.html" title="enum bdk_wallet::coin_selection::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Perform the coin selection</p>
  23 <ul>
  24 <li><code>database</code>: a reference to the wallet’s database that can be used to lookup additional
  25 details for a specific UTXO</li>
  26 <li><code>required_utxos</code>: the utxos that must be spent regardless of <code>target_amount</code> with their
  27 weight cost</li>
  28 <li><code>optional_utxos</code>: the remaining available utxos to satisfy <code>target_amount</code> with their
  29 weight cost</li>
  30 <li><code>fee_rate</code>: fee rate to use</li>
  31 <li><code>target_amount</code>: the outgoing amount in satoshis and the fees already
  32 accumulated from added outputs and transaction’s header.</li>
  33 <li><code>drain_script</code>: the script to use in case of change</li>
  34 </ul>
  35 </div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-CoinSelectionAlgorithm-for-BranchAndBoundCoinSelection" class="impl"><a class="src rightside" href="../../src/bdk_wallet/wallet/coin_selection.rs.html#432-531">source</a><a href="#impl-CoinSelectionAlgorithm-for-BranchAndBoundCoinSelection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CoinSelectionAlgorithm.html" title="trait bdk_wallet::coin_selection::CoinSelectionAlgorithm">CoinSelectionAlgorithm</a> for <a class="struct" href="struct.BranchAndBoundCoinSelection.html" title="struct bdk_wallet::coin_selection::BranchAndBoundCoinSelection">BranchAndBoundCoinSelection</a></h3></section><section id="impl-CoinSelectionAlgorithm-for-LargestFirstCoinSelection" class="impl"><a class="src rightside" href="../../src/bdk_wallet/wallet/coin_selection.rs.html#247-268">source</a><a href="#impl-CoinSelectionAlgorithm-for-LargestFirstCoinSelection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CoinSelectionAlgorithm.html" title="trait bdk_wallet::coin_selection::CoinSelectionAlgorithm">CoinSelectionAlgorithm</a> for <a class="struct" href="struct.LargestFirstCoinSelection.html" title="struct bdk_wallet::coin_selection::LargestFirstCoinSelection">LargestFirstCoinSelection</a></h3></section><section id="impl-CoinSelectionAlgorithm-for-OldestFirstCoinSelection" class="impl"><a class="src rightside" href="../../src/bdk_wallet/wallet/coin_selection.rs.html#277-303">source</a><a href="#impl-CoinSelectionAlgorithm-for-OldestFirstCoinSelection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CoinSelectionAlgorithm.html" title="trait bdk_wallet::coin_selection::CoinSelectionAlgorithm">CoinSelectionAlgorithm</a> for <a class="struct" href="struct.OldestFirstCoinSelection.html" title="struct bdk_wallet::coin_selection::OldestFirstCoinSelection">OldestFirstCoinSelection</a></h3></section></div><script src="../../trait.impl/bdk_wallet/wallet/coin_selection/trait.CoinSelectionAlgorithm.js" async></script></section></div></main></body></html>