bitcoin-s

mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-01-19 05:43:51 +01:00

History

Torkel Rogstad a76f61f97c Add configurable logging to data directory (#640 ) * Add logging to data directory In this commit we add the ability for the node, chain and wallet projects (+ the server) to log to the users data directory instead of whatever directory the binaries was launched from. This is inherently a bit more complicated than our previous setup, because we need to read the user directory before we can create loggers. As a result of this, some files/methods were moved around, so the relevant app config could be found in scope. We also introduce several logging categories that can be tuned individually through user configuration. These logggers are exposed both as traits that give a field `logger`, or as methods that return the required logger. * Add datadir configuration to AppConfig In this commit we add support for AppConfig to pick up the data directory configuration file. We also add a section to the contributing guide on how to tune logging levels. * Pass data directories explicitly for configuration	2019-08-01 06:01:56 -05:00
..
src/main/scala/org/bitcoins/wallet	Add configurable logging to data directory (#640 )	2019-08-01 06:01:56 -05:00
README.md	Process outgoing transactions (#555 )	2019-07-09 06:25:24 -05:00

Torkel Rogstad a76f61f97c Add configurable logging to data directory (#640 )

* Add logging to data directory

In this commit we add the ability for the node, chain
and wallet projects (+ the server) to log to the users
data directory instead of whatever directory the
binaries was launched from. This is inherently a bit
more complicated than our previous setup, because
we need to read the user directory before we can create
loggers. As a result of this, some files/methods were
moved around, so the relevant app config could be
found in scope.

We also  introduce several logging categories that can be
tuned individually through user configuration. These logggers
are exposed both as traits that give a field `logger`, or
as methods that return the required logger.

* Add datadir configuration to AppConfig

In this commit we add support for AppConfig to pick up
the data directory configuration file. We also add
a section to the contributing guide on how to tune
logging levels.

* Pass data directories explicitly for configuration

2019-08-01 06:01:56 -05:00

src/main/scala/org/bitcoins/wallet

Add configurable logging to data directory (#640 )

2019-08-01 06:01:56 -05:00

README.md

Process outgoing transactions (#555 )

2019-07-09 06:25:24 -05:00

README.md

wallet

This is meant to be a stand alone project that can be used as a cold storage wallet and hot wallet.

Features

utxo storage
key storage
key generation
coin selection
transaction building
fee calculation

Design choices

Private key material is just stored once, as the mnemonic code used to initialize the wallet
Addresses we hand out to users are stored with their BIP44/BIP49/BIP84 paths and script types, so that everything we need for spending the money sent to an address is derivable.
The wallet is a "dumb" wallet that acts mostly as a database of UTXOs, transactions and addresses, with associated operations on these. The wallet module does very little verification of incoming data about transactions, UTXOs and reorgs. We're aiming to write small, self contained modules, that can be composed together into more fully fledged systems. That means the chain and node modules does the actual verification of data we receive, and wallet just blindly acts on this. This results in a design where you can swap out node for a Bitcoin Core full node, use it with hardware wallets, or something else entirely. However, that also means that users of wallet that doesn't want to use the other modules we provide have to make sure that the data they are feeding the wallet is correct.

Database structure

We store information in the following tables:

TXOs - Contains both the information needed to spent it as well as information related to wallet state (confirmations, spent/unspent etc)
Addresses - must reference the account it belongs to
Accounts

Mnemonic encryption

The mnemonic seed to the Bitcoin-S wallet is written to disk, encrypted. The file name is $HOME/.bitcoin-s/$NETWORK/encrypted_bitcoin-s_seed.json. We store it in a JSON object that looks like this:

{
  "iv": "initializationVector",
  "cipherText": "encryptedCipherText",
  "salt": "saltUsedInEncryption"
}

The parts that's relevant to this part of the wallet is WalletStorage.scala (where we handle the actual reading from and writing to disk), EncryptedMnemonic.scala (where we convert an encrypted mnemonic to a cleartext mnemonic) and AesCrypt.scala (where do the actual encryption/decryption).

We use AES encryption for this, block cipher mode and PKCS5 padding. The wallet password is fed into the PBKDF2 key stretching function, using SHA512 as the HMAC function. This happens in PBKDF2.scala.