mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-25 09:02:11 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/docs/next/wallet/wallet-rescan.html

143 lines
18 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on 7f54b0954bbde6b4999be6fb8729daec73e754b1
2020-03-18 11:48:02 +00:00
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Wallet Rescans · bitcoin-s</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="With [BIP157](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki) you can cache block filters locally to use"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Wallet Rescans · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="With [BIP157](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki) you can cache block filters locally to use"/><meta property="og:image" content="https://bitcoin-s.org/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://bitcoin-s.org/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="https://fonts.googleapis.com/css?family=Montserrat:500"></script><script type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=UA-61958686-2"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/favicon.ico" alt="bitcoin-s"/><h2 class="headerTitleWithLogo">bitcoin-s</h2></a><a href="/versions"><h3>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/next/core/core-intro" target="_self">Docs</a></li><li class=""><a href="/api/org/bitcoins" target="_self">API</a></li><li class=""><a href="/help" target="_self">Help</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Wallet</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/getting-started">Add Bitcoin-S to your project</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Setup</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/getting-setup">Getting Bitcoin-S installed on your machine</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Applications</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/applications/cli">CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/next/applications/server">Application Server</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Chain</h3><ul class=""><li class="navListItem"><a
Deploy website Deploy website version based on c7f8ab72cf04bc54d0667ec6c892b56a060f1575
2020-03-13 21:19:19 +00:00
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/wallet/wallet-rescan.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Wallet Rescans</h1></header><article><div><span><p>With <a href="https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki">BIP157</a> you can cache block filters locally to use
later for rescans in the case you need to restore your wallets. Our <a href="../applications/chain.md">chain</a> project gives us
an API with the ability to query for filters.</p>
<p>You can rescan your wallet with filters with <a href="https://github.com/bitcoin-s/bitcoin-s/blob/1a3b6b5b1e4eb8442dfab8b1a9faeff74418bdb0/wallet/src/main/scala/org/bitcoins/wallet/api/WalletApi.scala#L399"><code>WalletApi.rescanNeutrinoWallet()</code></a></p>
<h3><a class="anchor" aria-hidden="true" id="example"></a><a href="#example" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example</h3>
<p>To run this example you need to make sure you have access to a bitcoind binary. You can download this with bitcoin-s by doing
<code>sbt downloadBitcoind</code></p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//we need an actor system and app config to power this</span>
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> system: <span class="hljs-type">ActorSystem</span> = <span class="hljs-type">ActorSystem</span>(<span class="hljs-string">s"wallet-rescan-example"</span>)
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = system.dispatcher
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> appConfig: <span class="hljs-type">BitcoinSAppConfig</span> = <span class="hljs-type">BitcoinSTestAppConfig</span>.getNeutrinoTestConfig()
<span class="hljs-comment">//ok now let's spin up a bitcoind and a bitcoin-s wallet with funds in it</span>
<span class="hljs-keyword">val</span> walletWithBitcoindF = <span class="hljs-keyword">for</span> {
w &lt;- <span class="hljs-type">BitcoinSWalletTest</span>.createWalletBitcoindNodeChainQueryApi()
} <span class="hljs-keyword">yield</span> w
<span class="hljs-keyword">val</span> walletF = walletWithBitcoindF.map(_.wallet)
<span class="hljs-keyword">val</span> bitcoindF = walletWithBitcoindF.map(_.bitcoind)
<span class="hljs-comment">//let's see what our initial wallet balance is</span>
<span class="hljs-keyword">val</span> initBalanceF = <span class="hljs-keyword">for</span> {
w &lt;- walletF
balance &lt;- w.getBalance()
} <span class="hljs-keyword">yield</span> {
println(<span class="hljs-string">s"Initial wallet balance=<span class="hljs-subst">${balance}</span>"</span>)
balance
}
<span class="hljs-comment">//ok great! We have money in the wallet to start,</span>
<span class="hljs-comment">//now let's delete our internal tables that hold our utxos</span>
<span class="hljs-comment">//and addresses so that we end up with a 0 balance</span>
<span class="hljs-keyword">val</span> clearedWalletF = <span class="hljs-keyword">for</span> {
w &lt;- walletF
_ &lt;- initBalanceF
clearedWallet &lt;- w.clearUtxosAndAddresses()
zeroBalance &lt;- clearedWallet.getBalance()
} <span class="hljs-keyword">yield</span> {
println(<span class="hljs-string">s"Balance after clearing utxos: <span class="hljs-subst">${zeroBalance}</span>"</span>)
clearedWallet
}
<span class="hljs-comment">//we need to pick how many addresses we want to generate off of our keychain</span>
<span class="hljs-comment">//when doing a rescan, this means we are generating 100 addrsses</span>
<span class="hljs-comment">//and then looking for matches. If we find a match, we generate _another_</span>
<span class="hljs-comment">//100 fresh addresses and search those. We keep doing this until we find</span>
<span class="hljs-comment">//100 addresses that do not contain a match.</span>
<span class="hljs-keyword">val</span> addrBatchSize = <span class="hljs-number">100</span>
<span class="hljs-comment">//ok now that we have a cleared wallet, we need to rescan and find our fudns again!</span>
<span class="hljs-keyword">val</span> rescannedBalanceF = <span class="hljs-keyword">for</span> {
w &lt;- clearedWalletF
_ &lt;- w.fullRescanNeurinoWallet(addrBatchSize)
balanceAfterRescan &lt;- w.getBalance()
} <span class="hljs-keyword">yield</span> {
println(<span class="hljs-string">s"Wallet balance after rescan: <span class="hljs-subst">${balanceAfterRescan}</span>"</span>)
()
}
<span class="hljs-comment">//cleanup</span>
<span class="hljs-keyword">val</span> cleanupF = <span class="hljs-keyword">for</span> {
_ &lt;- rescannedBalanceF
walletWithBitcoind &lt;- walletWithBitcoindF
_ &lt;- <span class="hljs-type">BitcoinSWalletTest</span>.destroyWalletWithBitcoind(walletWithBitcoind)
} <span class="hljs-keyword">yield</span> ()
<span class="hljs-type">Await</span>.result(cleanupF, <span class="hljs-number">60.</span>seconds)
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/dlc"><span class="arrow-prev">← </span><span>Executing A DLC with Bitcoin-S</span></a><a class="docs-next button" href="/docs/next/rpc/rpc-clients-intro"><span>Introduction</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '0a510688bf8448e19aeb380377d328d3',
indexName: 'bitcoin-s',
inputSelector: '#search_input_react'
});
</script></body></html>
Reference in a new issue Copy permalink