Add rudimentary docs for node, chain and wallet (#726)

This commit is contained in:
Torkel Rogstad 2019-09-02 15:16:44 +02:00 committed by Chris Stewart
parent a811f4a6d7
commit 69d9c3a3f2
4 changed files with 41 additions and 7 deletions

View file

@ -1,8 +1,15 @@
---
id: sync-chain
title: Syncing block headers with Bitcoin-S
title: Blockchain Verification
id: chain
---
Bitcoin-S comes bundled with a rudimentary blockchain verification
module. This module 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.
## Syncing and verifying block headers
Using the `chain` module of Bitcoin-S it's possible to
sync and verify block headers from the Bitcoin blockchain. In this document
we demonstrate how to do this, while persisting it to disk. We should be

13
docs/applications/node.md Normal file
View file

@ -0,0 +1,13 @@
---
title: Light client
id: node
---
Bitcoin-S comes bundled with a light client Bitcoin node. this client
is capable of doing verification of some parts of the blockchain,
and can act as a starting point for building Bitcoin applications
that need to connect to the P2P network.
This node 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.

View file

@ -1,8 +1,19 @@
---
id: create-wallet
title: Creating a Bitcoin-S wallet
title: Wallet
id: wallet
---
Bitcoin-S comes bundled with a rudimentary Bitcoin wallet. This wallet
is capable of managing private keys, generating addresses, constructing
and signing transactions, among other things. It is BIP32/BIP44/BIP49/BIP84
compatible.
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.
## Creating a wallet
This guide shows how to create a Bitcoin-S wallet and then
peer it with a `bitcoind` instance that relays
information about what is happening on the blockchain

View file

@ -12,10 +12,13 @@
"rpc/rpc-eclair",
"rpc/rpc-bitcoind"
],
"Chain": ["chain/sync-chain"],
"Wallet": ["wallet/create-wallet"],
"Applications": [
"applications/node",
"applications/wallet",
"applications/chain",
"applications/configuration"
],
"Contributing": ["contributing", "contributing-website"],
"Applications": ["applications/configuration"],
"Security": ["security"]
}
}