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="API documentation for the Rust `compact_filters` mod in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, compact_filters"><title>bdk::blockchain::compact_filters - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
2 <link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
3 <link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../bdk/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Module compact_filters</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../../index.html">bdk</a>::<wbr><a href="../index.html">blockchain</a></p><script>window.sidebarCurrent = {name: "compact_filters", ty: "mod", relpath: "../"};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
4 <a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../../src/bdk/blockchain/compact_filters/mod.rs.html#25-580" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../../index.html">bdk</a>::<wbr><a href="../index.html">blockchain</a>::<wbr><a class="mod" href="">compact_filters</a></span></h1><div class="item-info"><div class="stab portability">This is supported on <strong>crate feature <code>compact_filters</code></strong> only.</div></div><div class="docblock"><p>Compact Filters</p>
5 <p>This module contains a multithreaded implementation of an <a href="../../../bdk/blockchain/trait.Blockchain.html" title="Blockchain"><code>Blockchain</code></a> backend that
6 uses BIP157 (aka "Neutrino") to populate the wallet's <a href="../../../bdk/database/trait.Database.html">database</a>
7 by downloading compact filters from the P2P network.</p>
8 <p>Since there are currently very few peers "in the wild" that advertise the required service
9 flag, this implementation requires that one or more known peers are provided by the user.
10 No dns or other kinds of peer discovery are done internally.</p>
11 <p>Moreover, this module doesn't currently support detecting and resolving conflicts between
12 messages received by different peers. Thus, it's recommended to use this module by only
13 connecting to a single peer at a time, optionally by opening multiple connections if it's
14 desirable to use multiple threads at once to sync in parallel.</p>
15 <p>This is an <strong>EXPERIMENTAL</strong> feature, API and other major changes are expected.</p>
16 <h2 id="example" class="section-header"><a href="#example">Example</a></h2>
17 <div class="example-wrap"><pre class="rust rust-example-rendered">
18 <span class="kw">let</span> <span class="ident">num_threads</span> <span class="op">=</span> <span class="number">4</span>;
20 <span class="kw">let</span> <span class="ident">mempool</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Mempool</span>::<span class="ident">default</span>());
21 <span class="kw">let</span> <span class="ident">peers</span> <span class="op">=</span> (<span class="number">0</span>..<span class="ident">num_threads</span>)
22 .<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
23 <span class="ident">Peer</span>::<span class="ident">connect</span>(
24 <span class="string">"btcd-mainnet.lightning.computer:8333"</span>,
25 <span class="ident">Arc</span>::<span class="ident">clone</span>(<span class="kw-2">&</span><span class="ident">mempool</span>),
26 <span class="ident">Network</span>::<span class="ident">Bitcoin</span>,
29 .<span class="ident">collect</span>::<span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="kw">_</span>, <span class="kw">_</span><span class="op">></span><span class="op">></span>()<span class="question-mark">?</span>;
30 <span class="kw">let</span> <span class="ident">blockchain</span> <span class="op">=</span> <span class="ident">CompactFiltersBlockchain</span>::<span class="ident">new</span>(<span class="ident">peers</span>, <span class="string">"./wallet-filters"</span>, <span class="prelude-val">Some</span>(<span class="number">500_000</span>))<span class="question-mark">?</span>;</pre></div>
31 </div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
32 <table><tr class="module-item"><td><a class="struct" href="struct.BitcoinPeerConfig.html" title="bdk::blockchain::compact_filters::BitcoinPeerConfig struct">BitcoinPeerConfig</a></td><td class="docblock-short"><p>Data to connect to a Bitcoin P2P peer</p>
33 </td></tr><tr class="module-item"><td><a class="struct" href="struct.CompactFiltersBlockchain.html" title="bdk::blockchain::compact_filters::CompactFiltersBlockchain struct">CompactFiltersBlockchain</a></td><td class="docblock-short"><p>Structure implementing the required blockchain traits</p>
34 </td></tr><tr class="module-item"><td><a class="struct" href="struct.CompactFiltersBlockchainConfig.html" title="bdk::blockchain::compact_filters::CompactFiltersBlockchainConfig struct">CompactFiltersBlockchainConfig</a></td><td class="docblock-short"><p>Configuration for a <a href="../../../bdk/blockchain/compact_filters/struct.CompactFiltersBlockchain.html" title="CompactFiltersBlockchain"><code>CompactFiltersBlockchain</code></a></p>
35 </td></tr><tr class="module-item"><td><a class="struct" href="struct.Mempool.html" title="bdk::blockchain::compact_filters::Mempool struct">Mempool</a></td><td class="docblock-short"><p>Container for unconfirmed, but valid Bitcoin transactions</p>
36 </td></tr><tr class="module-item"><td><a class="struct" href="struct.Peer.html" title="bdk::blockchain::compact_filters::Peer struct">Peer</a></td><td class="docblock-short"><p>A Bitcoin peer</p>
37 </td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
38 <table><tr class="module-item"><td><a class="enum" href="enum.CompactFiltersError.html" title="bdk::blockchain::compact_filters::CompactFiltersError enum">CompactFiltersError</a></td><td class="docblock-short"><p>An error that can occur during sync with a <a href="../../../bdk/blockchain/compact_filters/struct.CompactFiltersBlockchain.html" title="CompactFiltersBlockchain"><code>CompactFiltersBlockchain</code></a></p>
39 </td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../";window.currentCrate = "bdk";</script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
projects / bitcoindevkit.org / blob