2025-01-25 15:35:06 +00:00
|
|
|
|
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Wallet Callbacks · bitcoin-s</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="#### Wallet Callbacks"/><meta name="docsearch:version" content="1.9.10"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Wallet Callbacks · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="#### Wallet Callbacks"/><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');
|
2025-01-25 15:35:06 +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.9.10</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><li class="navListItem"><a class="navItem" href="/docs/ui-setup">Installing the DLC Wallet UI</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 Ke
|
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);
|
|
|
|
|
|
};
|
|
|
|
|
|
}
|
|
|
|
|
|
});
|
2022-02-15 14:14:42 +00:00
|
|
|
|
</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-callbacks.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Wallet Callbacks</h1></header><article><div><span><h4><a class="anchor" aria-hidden="true" id="wallet-callbacks"></a><a href="#wallet-callbacks" 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 Callbacks</h4>
|
2021-02-03 23:50:45 +00:00
|
|
|
|
<p>Bitcoin-S support call backs for the following events that happen in the wallet:</p>
|
|
|
|
|
|
<ol>
|
|
|
|
|
|
<li>onTransactionProcessed</li>
|
|
|
|
|
|
<li>onTransactionBroadcast</li>
|
|
|
|
|
|
<li>onReservedUtxos</li>
|
|
|
|
|
|
<li>onNewAddressGenerated</li>
|
2022-02-15 14:14:42 +00:00
|
|
|
|
<li>onBlockProcessed</li>
|
2022-08-22 23:53:52 +00:00
|
|
|
|
<li>onRescanComplete</li>
|
2021-02-03 23:50:45 +00:00
|
|
|
|
</ol>
|
|
|
|
|
|
<p>That means every time one of these events happens, we will call your callback
|
|
|
|
|
|
so that you can be notified of the event. These callbacks will be run after the message has been
|
|
|
|
|
|
recieved and will execute synchronously. If any of them fail an error log will be output, and the remainder of the callbacks will continue.
|
|
|
|
|
|
Let's make an easy one:</p>
|
2022-02-15 14:14:42 +00:00
|
|
|
|
<h4><a class="anchor" aria-hidden="true" id="dlc-wallet-callbacks"></a><a href="#dlc-wallet-callbacks" 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>DLC Wallet callbacks</h4>
|
|
|
|
|
|
<p>Bitcoin-s support callbacks for the following events in the DLC wallet:</p>
|
|
|
|
|
|
<ol>
|
|
|
|
|
|
<li>onStateChange</li>
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
<p>That means everytime a DLC's state changes, your callback will be executed so
|
|
|
|
|
|
that you are notified of the event. For instance, if your DLC transitions from
|
|
|
|
|
|
<code>Offered</code> -> <code>Accepted</code>, your callback will be executed.</p>
|
2021-02-03 23:50:45 +00:00
|
|
|
|
<h4><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</h4>
|
|
|
|
|
|
<p>Here is an example of constructing a wallet and registering a callback, so you can be notified of an event.</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">"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> =
|
2021-10-20 13:11:39 +00:00
|
|
|
|
<span class="hljs-type">BitcoinSTestAppConfig</span>.getNeutrinoTestConfig().walletConf
|
2021-02-03 23:50:45 +00:00
|
|
|
|
|
2024-03-25 14:26:54 +00:00
|
|
|
|
<span class="hljs-keyword">val</span> bitcoind = <span class="hljs-type">BitcoindRpcClient</span>(<span class="hljs-type">BitcoindInstanceLocal</span>.fromConfFile())
|
2021-10-20 13:11:39 +00:00
|
|
|
|
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">"password"</span>))
|
2021-02-03 23:50:45 +00:00
|
|
|
|
|
|
|
|
|
|
<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 transaction on the network, finding relevant wallet outputs, verifying the transaction,</span>
|
|
|
|
|
|
<span class="hljs-comment">// or writing it to disk</span>
|
|
|
|
|
|
<span class="hljs-keyword">val</span> exampleProcessTx: <span class="hljs-type">OnTransactionProcessed</span> = (tx: <span class="hljs-type">Transaction</span>) =>
|
|
|
|
|
|
<span class="hljs-type">Future</span>.successful(println(<span class="hljs-string">s"Processed Tx: <span class="hljs-subst">${tx.txIdBE}</span>"</span>))
|
|
|
|
|
|
|
|
|
|
|
|
<span class="hljs-comment">// Create our WalletCallbacks that</span>
|
|
|
|
|
|
<span class="hljs-keyword">val</span> exampleCallbacks = <span class="hljs-type">WalletCallbacks</span>(
|
|
|
|
|
|
onTransactionProcessed = <span class="hljs-type">Vector</span>(exampleProcessTx))
|
|
|
|
|
|
|
|
|
|
|
|
<span class="hljs-comment">// Now we can create a wallet</span>
|
|
|
|
|
|
<span class="hljs-keyword">val</span> wallet =
|
2021-10-20 13:11:39 +00:00
|
|
|
|
<span class="hljs-type">Wallet</span>(
|
2021-02-03 23:50:45 +00:00
|
|
|
|
nodeApi = bitcoind,
|
2025-01-25 15:35:06 +00:00
|
|
|
|
chainQueryApi = bitcoind)
|
2021-02-03 23:50:45 +00:00
|
|
|
|
|
|
|
|
|
|
<span class="hljs-comment">// Finally, we can add the callbacks to our wallet config</span>
|
|
|
|
|
|
walletConf.addCallbacks(exampleCallbacks)
|
|
|
|
|
|
|
|
|
|
|
|
<span class="hljs-comment">// Then to trigger the event we can run</span>
|
|
|
|
|
|
<span class="hljs-keyword">val</span> exampleTx = <span class="hljs-type">Transaction</span>(
|
|
|
|
|
|
<span class="hljs-string">"0200000000010258e87a21b56daf0c23be8e7070456c336f7cbaa5c8757924f545887bb2abdd7500000000da00473044022074018ad4180097b873323c0015720b3684cc8123891048e7dbcd9b55ad679c99022073d369b740e3eb53dcefa33823c8070514ca55a7dd9544f157c167913261118c01483045022100f61038b308dc1da865a34852746f015772934208c6d24454393cd99bdf2217770220056e675a675a6d0a02b85b14e5e29074d8a25a9b5760bea2816f661910a006ea01475221029583bf39ae0a609747ad199addd634fa6108559d6c5cd39b4c2183f1ab96e07f2102dab61ff49a14db6a7d02b0cd1fbb78fc4b18312b5b4e54dae4dba2fbfef536d752aeffffffff838d0427d0ec650a68aa46bb0b098aea4422c071b2ca78352a077959d07cea1d01000000232200208c2353173743b595dfb4a07b72ba8e42e3797da74e87fe7d9d7497e3b2028903ffffffff0270aaf00800000000160014d85c2b71d0060b09c9886aeb815e50991dda124d00e1f5050000000016001400aea9a2e5f0f876a588df5546e8742d1d87008f000400473044022062eb7a556107a7c73f45ac4ab5a1dddf6f7075fb1275969a7f383efff784bcb202200c05dbb7470dbf2f08557dd356c7325c1ed30913e996cd3840945db12228da5f01473044022065f45ba5998b59a27ffe1a7bed016af1f1f90d54b3aa8f7450aa5f56a25103bd02207f724703ad1edb96680b284b56d4ffcb88f7fb759eabbe08aa30f29b851383d20147522103089dc10c7ac6db54f91329af617333db388cead0c231f723379d1b99030b02dc21023add904f3d6dcf59ddb906b0dee23529b7ffb9ed50e5e86151926860221f0e7352ae00000000"</span>)
|
2025-01-25 15:35:06 +00:00
|
|
|
|
wallet.transactionProcessing.processTransaction(exampleTx, <span class="hljs-type">None</span>)
|
2021-02-03 23:50:45 +00:00
|
|
|
|
</code></pre>
|
2025-01-01 16:02:04 +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"><span class="arrow-prev">← </span><span>Wallet</span></a><a class="docs-next button" href="/docs/wallet/wallet-get-address"><span>Wallet Get Address APIs</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/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>
|
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>
|
