2020-04-02 12:36:04 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Wallet · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "## Bitcoin-s wallet" / > < meta name = "docsearch:version" content = "next" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Wallet · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "## Bitcoin-s wallet" / > < 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');
2021-01-21 18:36:52 +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 > 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 = "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/next/getting-started" > Intro and Getting Started< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/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/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 > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/gui" > GUI< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Chain< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/chain" > Blockchain Verification< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/filter-sync" > Syncing Blockfilters< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/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/next/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/next/core/core-intro" > Core Module< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/addresses" > Generating Addresses< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/hd-keys" > HD Key Generation< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/adding-spks" > Adding New Script Types< / a > < / li > < li class = "navLis
2019-08-26 12:25:44 +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');
2019-12-13 15:35:21 -06:00
var headings = document.querySelector('.toc-headings');
2019-08-26 12:25:44 +00:00
headings & & headings.addEventListener('click', function(event) {
2019-12-13 15:35:21 -06:00
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
2019-08-26 12:25:44 +00:00
}
}, 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);
};
}
});
2020-03-13 15:02:35 +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.md" target = "_blank" rel = "noreferrer noopener" > Edit< / a > < h1 id = "__docusaurus" class = "postHeaderTitle" > Wallet< / h1 > < / header > < article > < div > < span > < h2 > < a class = "anchor" aria-hidden = "true" id = "bitcoin-s-wallet" > < / a > < a href = "#bitcoin-s-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 > Bitcoin-s wallet< / h2 >
2019-12-27 01:19:20 +00:00
< p > Bitcoin-s comes bundled with a rudimentary Bitcoin wallet. This wallet
2019-09-02 13:23:46 +00:00
is capable of managing private keys, generating addresses, constructing
and signing transactions, among other things. It is BIP32/BIP44/BIP49/BIP84
compatible.< / p >
< p > This wallet is currently only released as a library, and not as a binary.
This is because it (nor the documentation) is not deemed production
ready. Use at your own risk, and without too much money depending on it.< / p >
2019-12-27 01:19:20 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "how-is-the-bitcoin-s-wallet-implemented" > < / a > < a href = "#how-is-the-bitcoin-s-wallet-implemented" 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 > How is the bitcoin-s wallet implemented< / h3 >
< p > The bitcoin-s wallet is a scalable way for individuals up to large bitcoin exchanges to safely and securely store their bitcoin in a scalable way.< / p >
2021-01-21 18:36:52 +00:00
< p > All key interactions are delegated to the < a href = "/docs/next/key-manager/key-manager" > key-manager< / a > which is a minimal dependency library to store and use key material.< / p >
< p > By default, we store the encrypted root key in < code > $HOME/.bitcoin-s/seeds/encrypted-bitcoin-s-seed.json< / code > . This is the seed that is used for each of the wallets on each bitcoin network.
Multiple wallet seeds can be saved using the < code > bitcoin-s.wallet.walletName< / code > config option.
You can read more in the < a href = "/docs/next/key-manager/server-key-manager" > key manager docs< / a > .< / p >
2019-12-27 01:19:20 +00:00
< p > The wallet itself is used to manage the utxo life cycle, create transactions, and update wallet balances to show how much money you have the on a bitcoin network.< / p >
< p > We use < a href = "https://scala-slick.org/doc/3.3.1/" > slick< / a > as middleware to support different database types. Depending on your use case, you can use something as simple as sqlite, or something much more scalable like postgres.< / 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 > This guide shows how to create a Bitcoin-s wallet and then
2019-08-26 12:25:44 +00:00
peer it with a < code > bitcoind< / code > instance that relays
information about what is happening on the blockchain
through the P2P network.< / p >
< p > This is useful if you want more flexible signing procedures in
the JVM ecosystem and more granular control over your
UTXOs with popular database like Postgres, SQLite, etc.< / p >
< p > This code snippet you have a running < code > bitcoind< / code > instance, locally
on regtest.< / p >
2019-08-30 20:18:52 +00:00
< pre > < code class = "hljs css language-scala" > implicit val ec = scala.concurrent.ExecutionContext.global
2019-08-26 12:25:44 +00:00
2020-03-10 19:06:52 +00:00
2019-08-26 12:25:44 +00:00
val config = ConfigFactory.parseString {
2020-12-11 22:35:47 +00:00
" " "
2019-08-26 12:25:44 +00:00
| bitcoin-s {
| network = regtest
| }
2020-12-11 22:35:47 +00:00
" " " .stripMargin
2019-08-26 12:25:44 +00:00
}
2020-03-10 19:06:52 +00:00
2020-12-11 22:35:47 +00:00
val datadir = Files.createTempDirectory(" bitcoin-s-wallet" )
2019-08-26 12:25:44 +00:00
2020-03-10 19:06:52 +00:00
2020-08-14 14:08:00 +00:00
implicit val walletConfig = WalletAppConfig(datadir, config)
2019-08-26 12:25:44 +00:00
// we also need to store chain state for syncing purposes
2020-08-14 14:08:00 +00:00
implicit val chainConfig = ChainAppConfig(datadir, config)
2019-08-26 12:25:44 +00:00
// when this future completes, we have
// created the necessary directories and
// databases for managing both chain state
// and wallet state
val configF: Future[Unit] = for {
2020-08-26 21:42:03 +00:00
_ < - walletConfig.start()
_ < - chainConfig.start()
2019-08-26 12:25:44 +00:00
} yield ()
val bitcoindInstance = BitcoindInstance.fromDatadir()
2019-08-30 20:18:52 +00:00
val bitcoind = BitcoindRpcClient(bitcoindInstance)
2019-08-26 12:25:44 +00:00
// when this future completes, we have
// synced our chain handler to our bitcoind
// peer
val syncF: Future[ChainApi] = configF.flatMap { _ =>
val getBestBlockHashFunc = { () =>
bitcoind.getBestBlockHash
}
2020-03-10 19:06:52 +00:00
2019-08-26 12:25:44 +00:00
val getBlockHeaderFunc = { hash: DoubleSha256DigestBE =>
bitcoind.getBlockHeader(hash).map(_.blockHeader)
}
val blockHeaderDAO = BlockHeaderDAO()
2019-09-25 18:26:03 +00:00
val compactFilterHeaderDAO = CompactFilterHeaderDAO()
val compactFilterDAO = CompactFilterDAO()
2019-08-26 12:25:44 +00:00
val chainHandler = ChainHandler(
blockHeaderDAO,
2019-09-25 18:26:03 +00:00
compactFilterHeaderDAO,
compactFilterDAO,
blockFilterCheckpoints = Map.empty)
2019-08-26 12:25:44 +00:00
ChainSync.sync(chainHandler, getBlockHeaderFunc, getBestBlockHashFunc)
}
2019-12-27 01:19:20 +00:00
//initialize our key manager, where we store our keys
2020-12-11 22:35:47 +00:00
val aesPasswordOpt = Some(AesPassword.fromString(" password" ))
2020-01-03 17:19:17 +00:00
//you can add a password here if you want
2020-12-11 22:35:47 +00:00
//val bip39PasswordOpt = Some(" my-password-here" )
2020-01-03 17:19:17 +00:00
val bip39PasswordOpt = None
2020-12-11 22:35:47 +00:00
val keyManager = BIP39KeyManager.initialize(aesPasswordOpt, walletConfig.kmParams, bip39PasswordOpt).getOrElse {
throw new RuntimeException(s" Failed to initalize key manager" )
2019-12-27 01:19:20 +00:00
}
2019-08-26 12:25:44 +00:00
// once this future completes, we have a initialized
// wallet
2020-01-02 20:24:54 +00:00
val wallet = Wallet(keyManager, new NodeApi {
2020-04-21 23:08:58 +00:00
override def broadcastTransaction(tx: Transaction): Future[Unit] = Future.successful(())
2020-01-02 20:24:54 +00:00
override def downloadBlocks(blockHashes: Vector[DoubleSha256Digest]): Future[Unit] = Future.successful(())
}, new ChainQueryApi {
2020-04-29 14:59:01 +00:00
override def epochSecondToBlockHeight(time: Long): Future[Int] = Future.successful(0)
2020-01-02 20:24:54 +00:00
override def getBlockHeight(blockHash: DoubleSha256DigestBE): Future[Option[Int]] = Future.successful(None)
override def getBestBlockHash(): Future[DoubleSha256DigestBE] = Future.successful(DoubleSha256DigestBE.empty)
override def getNumberOfConfirmations(blockHashOpt: DoubleSha256DigestBE): Future[Option[Int]] = Future.successful(None)
override def getFilterCount: Future[Int] = Future.successful(0)
override def getHeightByBlockStamp(blockStamp: BlockStamp): Future[Int] = Future.successful(0)
override def getFiltersBetweenHeights(startHeight: Int, endHeight: Int): Future[Vector[FilterResponse]] = Future.successful(Vector.empty)
2020-06-08 12:26:22 +00:00
}, ConstantFeeRateProvider(SatoshisPerVirtualByte.one), creationTime = Instant.now)
2020-04-28 19:08:10 +00:00
val walletF: Future[WalletApi] = configF.flatMap { _ =>
2020-01-03 17:19:17 +00:00
Wallet.initialize(wallet,bip39PasswordOpt)
2019-08-26 12:25:44 +00:00
}
// when this future completes, ww have sent a transaction
// from bitcoind to the Bitcoin-S wallet
2019-12-14 20:14:08 +00:00
val transactionF: Future[(Transaction, Option[DoubleSha256DigestBE])] = for {
2019-08-26 12:25:44 +00:00
wallet < - walletF
address < - wallet.getNewAddress()
txid < - bitcoind.sendToAddress(address, 3.bitcoin)
transaction < - bitcoind.getRawTransaction(txid)
2019-12-14 20:14:08 +00:00
} yield (transaction.hex, transaction.blockhash)
2019-08-26 12:25:44 +00:00
// when this future completes, we have processed
// the transaction from bitcoind, and we have
// queried our balance for the current balance
val balanceF: Future[CurrencyUnit] = for {
wallet < - walletF
2019-12-14 20:14:08 +00:00
(tx, blockhash) < - transactionF
_ < - wallet.processTransaction(tx, blockhash)
2020-12-11 22:35:47 +00:00
balance < - wallet.getBalance()
2019-08-26 12:25:44 +00:00
} yield balance
balanceF.foreach { balance =>
2020-12-11 22:35:47 +00:00
println(s" Bitcoin-S wallet balance: $balance" )
2019-08-26 12:25:44 +00:00
}
< / code > < / pre >
2021-01-01 15:31:00 +00:00
< / span > < / div > < / article > < / div > < div class = "docs-prevnext" > < a class = "docs-prev button" href = "/docs/next/node/node-api" > < span class = "arrow-prev" > ← < / span > < span > Node API< / span > < / a > < a class = "docs-next button" href = "/docs/next/wallet/wallet-callbacks" > < span > Wallet Callbacks< / span > < span class = "arrow-next" > →< / span > < / a > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < li > < a href = "#bitcoin-s-wallet" > Bitcoin-s wallet< / a > < ul class = "toc-headings" > < li > < a href = "#how-is-the-bitcoin-s-wallet-implemented" > How is the bitcoin-s wallet implemented< / a > < / li > < li > < a href = "#example" > Example< / 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 © 2021 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 >
2019-08-26 12:25:44 +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 >
