2021-10-17 17:51:31 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Wallet Sync · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "## High level wallet state" / > < meta name = "docsearch:version" content = "1.8.0" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Wallet Sync · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "## High level wallet state" / > < 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" / > < script >
2021-02-03 23:50:45 +00:00
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61958686-2', 'auto');
ga('send', 'pageview');
2022-02-13 22:51:48 +00:00
< / script > < 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 > 1.8.0< / h3 > < / a > < div class = "navigationWrapper navigationSlider" > < nav class = "slidingNav" > < ul class = "nav-site nav-site-internal" > < li class = "siteNavGroupActive" > < a href = "/docs/core/core-intro" target = "_self" > Docs< / a > < / li > < li class = "" > < a href = "/download" target = "_self" > Download< / 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/getting-started" > Intro and Getting Started< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/bips" > Supported BIPs< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Getting Setup< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/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/applications/cli" > CLI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/applications/server" > Application Server< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/applications/gui" > GUI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/applications/server-systemd" > Systemd installation< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Chain< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/chain/chain" > Blockchain Verification< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/chain/filter-sync" > Syncing Blockfilters< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/chain/chain-query-api" > Chain Query API< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Configuration< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/config/configuration" > Application Configuration< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Core Module< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/core-intro" > Core Module< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/addresses" > Generating Addresses< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/hd-keys" > HD Key Generation< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/adding-spks" > Adding Ne
2021-02-03 23:50:45 +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-sync.md" target = "_blank" rel = "noreferrer noopener" > Edit< / a > < h1 id = "__docusaurus" class = "postHeaderTitle" > Wallet Sync< / h1 > < / header > < article > < div > < span > < h2 > < a class = "anchor" aria-hidden = "true" id = "high-level-wallet-state" > < / a > < a href = "#high-level-wallet-state" 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 > High level wallet state< / h2 >
< p > Our wallet infrastructure has a specific table called < code > state_descriptors< / code > .
This tracks chain state for our wallet.
Here is an example of the contents of this table< / p >
< blockquote >
< p > sqlite> select * from state_descriptors;
SyncHeight|0000000000000000000134aa9e949ea1d053042b8dfa59bdc73b0322a88f009e 665741< / p >
< / blockquote >
< p > If you look carefully in the second column, you will see a string encoding indicating
what the wallet state is. In this case, the last block hash seen by the wallet is< / p >
< blockquote >
< p > 0000000000000000000134aa9e949ea1d053042b8dfa59bdc73b0322a88f009e< / p >
< / blockquote >
< p > and height< / p >
< blockquote >
< p > 665741< / p >
< / blockquote >
< p > If you have access to a wallet, you can call< / p >
< p > < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/36b5fc142715f8ab3ad053465d53dc29ab319790/wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala#L160" > < code > wallet.getSyncDescriptorOpt< / code > < / a > to get access to this information< / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "wallet-state-from-the-cli" > < / a > < a href = "#wallet-state-from-the-cli" 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 > Wallet state from the cli< / h4 >
< p > Alternatively, you can retrieve this information with < code > bitcoin-s-cli< / code > < / p >
< pre > < code class = "hljs" > ./< span class = "hljs-keyword" > bitcoin-s-cli < / span > walletinfo
{
< span class = "hljs-string" > "wallet"< / span > : {
< span class = "hljs-string" > "keymanager"< / span > : {
< span class = "hljs-string" > "rootXpub"< / span > : < span class = "hljs-string" > "..."< / span >
},
< span class = "hljs-string" > "xpub"< / span > : < span class = "hljs-string" > "..."< / span > ,
< span class = "hljs-string" > "hdPath"< / span > : < span class = "hljs-string" > "..."< / span > ,
< span class = "hljs-string" > "height"< / span > : < span class = "hljs-number" > 1906239< / span > ,
< span class = "hljs-string" > "blockHash"< / span > : < span class = "hljs-string" > "00000000dcf1066b8cd764a6104a9b5e95a55cd31adf9107974b2581ac90fdb9"< / span >
}
}
< / code > < / pre >
< h2 > < a class = "anchor" aria-hidden = "true" id = "syncing-a-wallet" > < / a > < a href = "#syncing-a-wallet" 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 > Syncing a wallet< / h2 >
< p > Bitcoin-s provides a utility object called < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/f3e81d027dfdda79e26642d5c29d381874ee72da/wallet/src/main/scala/org/bitcoins/wallet/sync/WalletSync.scala#L10" > < code > WalletSync< / code > < / a >
that provides useful utilities for syncing a bitcoin-s wallet.< / p >
< h3 > < a class = "anchor" aria-hidden = "true" id = "syncing-wallet-for-with-access-to-full-blocks" > < / a > < a href = "#syncing-wallet-for-with-access-to-full-blocks" 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 > Syncing wallet for with access to full blocks< / h3 >
< p > Inside of < code > WalletSync< / code > we have a method called < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/f3e81d027dfdda79e26642d5c29d381874ee72da/wallet/src/main/scala/org/bitcoins/wallet/sync/WalletSync.scala#L18" > < code > WalletSync.syncFullBlocks< / code > < / a >
This method takes 4 parameters< / p >
< ul >
< li > a < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/36b5fc142715f8ab3ad053465d53dc29ab319790/wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala#L46" > Wallet< / a > to sync< / li >
< li > < code > getBlockHeaderFunc< / code > is a function to retrieve a block header based on a blockHash< / li >
< li > < code > getBestBlockHashFunc< / code > is a function to retrieve the best block hash for our blockchain< / li >
< li > < code > getBlockFunc< / code > is a function to retrieve a full < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/8a148357d560a40bf21e7c0e3f4074cd276534fe/core/src/main/scala/org/bitcoins/core/protocol/blockchain/Block.scala#L18" > < code > Block< / code > < / a > that corresponds to a block hash< / li >
< / ul >
< p > Given these for things, we can use < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/f3e81d027dfdda79e26642d5c29d381874ee72da/wallet/src/main/scala/org/bitcoins/wallet/sync/WalletSync.scala#L18" > < code > WalletSync.syncFullBlocks< / code > < / a > to sync our entire wallet.< / p >
< p > Here is a code example< / p >
< pre > < code class = "hljs css language-scala" > < 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-sync-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-comment" > // this reads authentication credentials and< / span >
< span class = "hljs-comment" > // connection details from the default data< / span >
< span class = "hljs-comment" > // directory on your platform< / span >
< span class = "hljs-keyword" > val< / span > client = < span class = "hljs-type" > BitcoindRpcClient< / span > .fromDatadir(binary=< span class = "hljs-keyword" > new< / span > < span class = "hljs-type" > File< / span > (< span class = "hljs-string" > "/path/to/bitcoind"< / span > ), datadir=< span class = "hljs-keyword" > new< / span > < span class = "hljs-type" > File< / span > (< span class = "hljs-string" > "/path/to/bitcoind-datadir"< / span > ))
< span class = "hljs-comment" > //yay! Now we have a started bitcoind.< / span >
< span class = "hljs-comment" > //We will use this as our datasource for syncing our wallet< / span >
< span class = "hljs-keyword" > val< / span > bitcoindRpcClientF: < span class = "hljs-type" > Future< / span > [< span class = "hljs-type" > BitcoindRpcClient< / span > ] = client.start()
< span class = "hljs-comment" > //wait for bitcoind to get started< / span >
< span class = "hljs-keyword" > val< / span > bitcoind = < span class = "hljs-type" > Await< / span > .result(bitcoindRpcClientF, < span class = "hljs-number" > 10.< / span > seconds)
< span class = "hljs-keyword" > val< / span > getBestBlockHashFunc = () => bitcoind.getBestBlockHash
< span class = "hljs-keyword" > val< / span > getBlockHeaderFunc = { hash: < span class = "hljs-type" > DoubleSha256DigestBE< / span > => bitcoind.getBlockHeaderRaw(hash) }
< span class = "hljs-keyword" > val< / span > getBlockFunc = {hash: < span class = "hljs-type" > DoubleSha256DigestBE< / span > => bitcoind.getBlockRaw(hash) }
< span class = "hljs-comment" > //yay! We are now all setup. Using our 3 functions above and a wallet, we can now sync< / span >
< span class = "hljs-comment" > //a fresh wallet< / span >
< span class = "hljs-keyword" > implicit< / span > < span class = "hljs-keyword" > val< / span > walletAppConfig = < span class = "hljs-type" > WalletAppConfig< / span > .fromDefaultDatadir()
2021-10-20 13:11:39 +00:00
2021-10-17 17:51:31 +00:00
< span class = "hljs-keyword" > val< / span > feeRateProvider: < span class = "hljs-type" > FeeRateApi< / span > = < span class = "hljs-type" > MempoolSpaceProvider< / span > .fromBlockTarget(< span class = "hljs-number" > 6< / span > , proxyParams = < span class = "hljs-type" > None< / span > )
2021-10-20 13:11:39 +00:00
< span class = "hljs-keyword" > val< / span > wallet = < span class = "hljs-type" > Wallet< / span > (bitcoind, bitcoind, feeRateProvider)
2021-02-03 23:50:45 +00:00
< span class = "hljs-comment" > //yay! we have a synced wallet< / span >
< span class = "hljs-keyword" > val< / span > syncedWalletF = < span class = "hljs-type" > WalletSync< / span > .syncFullBlocks(wallet,
getBlockHeaderFunc,
getBestBlockHashFunc,
getBlockFunc)
< / code > < / pre >
2022-01-04 15:29:38 +00:00
< / span > < / div > < / article > < / div > < div class = "docLastUpdate" > < em > Last updated on 10/20/2021 by Chris Stewart< / em > < / div > < div class = "docs-prevnext" > < a class = "docs-prev button" href = "/docs/wallet/wallet-rescan" > < span class = "arrow-prev" > ← < / span > < span > Wallet Rescans< / span > < / a > < a class = "docs-next button" href = "/docs/wallet/wallet-rpc" > < span > Wallet RPC Examples< / span > < span class = "arrow-next" > →< / span > < / a > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < li > < a href = "#high-level-wallet-state" > High level wallet state< / a > < / li > < li > < a href = "#syncing-a-wallet" > Syncing a wallet< / a > < ul class = "toc-headings" > < li > < a href = "#syncing-wallet-for-with-access-to-full-blocks" > Syncing wallet for with access to full blocks< / a > < / li > < / ul > < / li > < / ul > < / 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/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" 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 © 2022 Suredbits & the bitcoin-s developers< / section > < / footer > < / div > < script type = "text/javascript" src = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js" > < / script > < script >
2021-02-03 23:50:45 +00:00
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 >
