mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2025-03-15 12:20:06 +01:00
190 lines
No EOL
20 KiB
HTML
190 lines
No EOL
20 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Chain Query API · bitcoin-s</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="### ChainQueryAPI"/><meta name="docsearch:version" content="1.9.10"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Chain Query API · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="### ChainQueryAPI"/><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>
|
|
(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');
|
|
</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.9.10</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><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="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/chain-query-api.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Chain Query API</h1></header><article><div><span><h3><a class="anchor" aria-hidden="true" id="chainqueryapi"></a><a href="#chainqueryapi" 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>ChainQueryAPI</h3>
|
|
<p>The ChainQueryApi is how the wallet project stays aware of the current best chain.
|
|
This allows the wallet for example to calculate the number of confirmations for a transaction,
|
|
get the current chain tip, or even retrieve block filters for a given set of blocks.</p>
|
|
<p>Since this is an API it can be hooked up to the <code>chain</code> module of bitcoin-s but it can also be linked to
|
|
any other implementation of your choosing. This allows you to use the bitcoin-s wallet in any schema that you
|
|
want.</p>
|
|
<p>The functions that the ChainQueryApi supports are:</p>
|
|
<pre><code class="hljs css language-scala"><span class="hljs-class"><span class="hljs-keyword">trait</span> <span class="hljs-title">ChainQueryApi</span> </span>{
|
|
|
|
<span class="hljs-comment">/** Gets the height of the given block */</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getBlockHeight</span></span>(blockHash: <span class="hljs-type">DoubleSha256DigestBE</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Option</span>[<span class="hljs-type">Int</span>]]
|
|
|
|
<span class="hljs-comment">/** Gets the hash of the block that is what we consider "best" */</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getBestBlockHash</span></span>(): <span class="hljs-type">Future</span>[<span class="hljs-type">DoubleSha256DigestBE</span>]
|
|
|
|
<span class="hljs-comment">/** Gets number of confirmations for the given block hash*/</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getNumberOfConfirmations</span></span>(
|
|
blockHashOpt: <span class="hljs-type">DoubleSha256DigestBE</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Option</span>[<span class="hljs-type">Int</span>]]
|
|
|
|
<span class="hljs-comment">/** Gets the number of compact filters in the database */</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getFilterCount</span></span>: <span class="hljs-type">Future</span>[<span class="hljs-type">Int</span>]
|
|
|
|
<span class="hljs-comment">/** Returns the block height of the given block stamp */</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getHeightByBlockStamp</span></span>(blockStamp: <span class="hljs-type">BlockStamp</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Int</span>]
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getFiltersBetweenHeights</span></span>(
|
|
startHeight: <span class="hljs-type">Int</span>,
|
|
endHeight: <span class="hljs-type">Int</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Vector</span>[<span class="hljs-type">FilterResponse</span>]]
|
|
}
|
|
</code></pre>
|
|
<h2><a class="anchor" aria-hidden="true" id="chain-query-with-bitcoind"></a><a href="#chain-query-with-bitcoind" 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>Chain query with bitcoind</h2>
|
|
<p>As an example, we will show you how to use the <code>ChainQueryApi</code> and bitcoind to query chain data.</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"node-api-example"</span>)
|
|
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContextExecutor</span> = system.dispatcher
|
|
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> walletConf: <span class="hljs-type">WalletAppConfig</span> =
|
|
<span class="hljs-type">BitcoinSTestAppConfig</span>.getSpvTestConfig().walletConf
|
|
|
|
<span class="hljs-comment">// let's use a helper method to get a v19 bitcoind</span>
|
|
<span class="hljs-comment">// and a ChainApi</span>
|
|
<span class="hljs-keyword">val</span> bitcoind = <span class="hljs-type">BitcoindV19RpcClient</span>(<span class="hljs-type">BitcoindInstance</span>.fromConfigFile())
|
|
<span class="hljs-keyword">val</span> nodeApi = <span class="hljs-type">BitcoinSWalletTest</span>.<span class="hljs-type">MockNodeApi</span>
|
|
|
|
<span class="hljs-comment">// Create our key manager</span>
|
|
<span class="hljs-keyword">val</span> keyManagerE = <span class="hljs-type">BIP39KeyManager</span>.initialize(kmParams = walletConf.kmParams,
|
|
bip39PasswordOpt = <span class="hljs-type">None</span>)
|
|
|
|
<span class="hljs-keyword">val</span> keyManager = keyManagerE <span class="hljs-keyword">match</span> {
|
|
<span class="hljs-keyword">case</span> <span class="hljs-type">Right</span>(keyManager) => keyManager
|
|
<span class="hljs-keyword">case</span> <span class="hljs-type">Left</span>(err) =>
|
|
<span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> <span class="hljs-type">RuntimeException</span>(<span class="hljs-string">s"Cannot initialize key manager err=<span class="hljs-subst">$err</span>"</span>)
|
|
}
|
|
|
|
<span class="hljs-comment">// This function can be used to create a callback for when our chain api receives a transaction, block, or</span>
|
|
<span class="hljs-comment">// a block filter, the returned NodeCallbacks will contain the necessary items to initialize the callbacks</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">createCallbacks</span></span>(
|
|
processTransaction: <span class="hljs-type">Transaction</span> => <span class="hljs-type">Unit</span>,
|
|
processCompactFilter: (<span class="hljs-type">DoubleSha256Digest</span>, <span class="hljs-type">GolombFilter</span>) => <span class="hljs-type">Unit</span>,
|
|
processBlock: <span class="hljs-type">Block</span> => <span class="hljs-type">Unit</span>): <span class="hljs-type">NodeCallbacks</span> = {
|
|
<span class="hljs-keyword">lazy</span> <span class="hljs-keyword">val</span> onTx: <span class="hljs-type">OnTxReceived</span> = { tx =>
|
|
processTransaction(tx)
|
|
()
|
|
}
|
|
<span class="hljs-keyword">lazy</span> <span class="hljs-keyword">val</span> onCompactFilter: <span class="hljs-type">OnCompactFilterReceived</span> = {
|
|
(blockHash, blockFilter) =>
|
|
processCompactFilter(blockHash, blockFilter)
|
|
()
|
|
}
|
|
<span class="hljs-keyword">lazy</span> <span class="hljs-keyword">val</span> onBlock: <span class="hljs-type">OnBlockReceived</span> = { block =>
|
|
processBlock(block)
|
|
}
|
|
<span class="hljs-type">NodeCallbacks</span>(onTxReceived = <span class="hljs-type">Seq</span>(onTx),
|
|
onBlockReceived = <span class="hljs-type">Seq</span>(onBlock),
|
|
onCompactFilterReceived = <span class="hljs-type">Seq</span>(onCompactFilter))
|
|
}
|
|
|
|
<span class="hljs-comment">// Here is a super simple example of a callback, this could be replaced with anything, from</span>
|
|
<span class="hljs-comment">// relaying the block on the network, finding relevant wallet transactions, verifying the block,</span>
|
|
<span class="hljs-comment">// or writing it to disk</span>
|
|
<span class="hljs-keyword">val</span> exampleProcessTx = (tx: <span class="hljs-type">Transaction</span>) =>
|
|
println(<span class="hljs-string">s"Received tx: <span class="hljs-subst">${tx.txIdBE}</span>"</span>)
|
|
|
|
<span class="hljs-keyword">val</span> exampleProcessBlock = (block: <span class="hljs-type">Block</span>) =>
|
|
println(<span class="hljs-string">s"Received block: <span class="hljs-subst">${block.blockHeader.hashBE}</span>"</span>)
|
|
|
|
<span class="hljs-keyword">val</span> exampleProcessFilter =
|
|
(blockHash: <span class="hljs-type">DoubleSha256Digest</span>, filter: <span class="hljs-type">GolombFilter</span>) =>
|
|
println(<span class="hljs-string">s"Received filter: <span class="hljs-subst">${blockHash.flip.hex}</span> <span class="hljs-subst">${filter.hash.flip.hex}</span>"</span>)
|
|
|
|
<span class="hljs-keyword">val</span> exampleCallbacks =
|
|
createCallbacks(exampleProcessTx, exampleProcessFilter, exampleProcessBlock)
|
|
|
|
<span class="hljs-comment">// Here is where we are defining our actual chain api, Ideally this could be it's own class</span>
|
|
<span class="hljs-comment">// but for the examples sake we will keep it small.</span>
|
|
<span class="hljs-keyword">val</span> chainApi = <span class="hljs-keyword">new</span> <span class="hljs-type">ChainQueryApi</span> {
|
|
|
|
<span class="hljs-comment">/** Gets the height of the given block */</span>
|
|
<span class="hljs-keyword">override</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getBlockHeight</span></span>(
|
|
blockHash: <span class="hljs-type">DoubleSha256DigestBE</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Option</span>[<span class="hljs-type">Int</span>]] = {
|
|
bitcoind.getBlock(blockHash).map(block => <span class="hljs-type">Some</span>(block.height))
|
|
}
|
|
|
|
<span class="hljs-comment">/** Gets the hash of the block that is what we consider "best" */</span>
|
|
<span class="hljs-keyword">override</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getBestBlockHash</span></span>(): <span class="hljs-type">Future</span>[<span class="hljs-type">DoubleSha256DigestBE</span>] = {
|
|
bitcoind.getBestBlockHash
|
|
}
|
|
|
|
<span class="hljs-comment">/** Gets number of confirmations for the given block hash */</span>
|
|
<span class="hljs-keyword">override</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getNumberOfConfirmations</span></span>(
|
|
blockHash: <span class="hljs-type">DoubleSha256DigestBE</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Option</span>[<span class="hljs-type">Int</span>]] = {
|
|
<span class="hljs-keyword">for</span> {
|
|
tip <- bitcoind.getBlockCount
|
|
block <- bitcoind.getBlock(blockHash)
|
|
} <span class="hljs-keyword">yield</span> {
|
|
<span class="hljs-type">Some</span>(tip - block.height + <span class="hljs-number">1</span>)
|
|
}
|
|
}
|
|
|
|
<span class="hljs-comment">/** Gets the number of compact filters in the database */</span>
|
|
<span class="hljs-keyword">override</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getFilterCount</span></span>: <span class="hljs-type">Future</span>[<span class="hljs-type">Int</span>] = {
|
|
<span class="hljs-comment">// since bitcoind should have the filter for</span>
|
|
<span class="hljs-comment">// every block we can just return the block height</span>
|
|
bitcoind.getBlockCount
|
|
}
|
|
|
|
<span class="hljs-comment">/** Returns the block height of the given block stamp */</span>
|
|
<span class="hljs-keyword">override</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getHeightByBlockStamp</span></span>(blockStamp: <span class="hljs-type">BlockStamp</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Int</span>] = {
|
|
blockStamp <span class="hljs-keyword">match</span> {
|
|
<span class="hljs-keyword">case</span> blockHeight: <span class="hljs-type">BlockStamp</span>.<span class="hljs-type">BlockHeight</span> =>
|
|
<span class="hljs-type">Future</span>.successful(blockHeight.height)
|
|
<span class="hljs-keyword">case</span> blockHash: <span class="hljs-type">BlockStamp</span>.<span class="hljs-type">BlockHash</span> =>
|
|
getBlockHeight(blockHash.hash).map(_.get)
|
|
<span class="hljs-keyword">case</span> blockTime: <span class="hljs-type">BlockStamp</span>.<span class="hljs-type">BlockTime</span> =>
|
|
<span class="hljs-type">Future</span>.failed(<span class="hljs-keyword">new</span> <span class="hljs-type">RuntimeException</span>(<span class="hljs-string">s"Not implemented: <span class="hljs-subst">$blockTime</span>"</span>))
|
|
}
|
|
}
|
|
|
|
<span class="hljs-keyword">override</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">getFiltersBetweenHeights</span></span>(
|
|
startHeight: <span class="hljs-type">Int</span>,
|
|
endHeight: <span class="hljs-type">Int</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">Vector</span>[<span class="hljs-type">FilterResponse</span>]] = {
|
|
<span class="hljs-keyword">val</span> filterFs = startHeight
|
|
.until(endHeight)
|
|
.map { height =>
|
|
<span class="hljs-keyword">for</span> {
|
|
hash <- bitcoind.getBlockHash(height)
|
|
filter <- bitcoind.getBlockFilter(hash, <span class="hljs-type">FilterType</span>.<span class="hljs-type">Basic</span>)
|
|
} <span class="hljs-keyword">yield</span> {
|
|
<span class="hljs-type">FilterResponse</span>(filter.filter, hash, height)
|
|
}
|
|
}
|
|
.toVector
|
|
|
|
<span class="hljs-type">Future</span>.sequence(filterFs)
|
|
}
|
|
}
|
|
|
|
<span class="hljs-comment">// Finally, we can initialize our wallet with our own node api</span>
|
|
<span class="hljs-keyword">val</span> wallet =
|
|
<span class="hljs-type">Wallet</span>(keyManager = keyManager, nodeApi = nodeApi, chainQueryApi = chainApi)
|
|
|
|
<span class="hljs-comment">// Then to trigger one of the events we can run</span>
|
|
wallet.chainQueryApi.getFiltersBetweenHeights(<span class="hljs-number">100</span>, <span class="hljs-number">150</span>)
|
|
</code></pre>
|
|
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 3/13/2020 by Ben Carman</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#chain-query-with-bitcoind">Chain query with bitcoind</a></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 © 2025 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>
|
|
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> |