diff --git a/docs/chain/sync-chain.md b/docs/applications/chain.md similarity index 86% rename from docs/chain/sync-chain.md rename to docs/applications/chain.md index fe169e7b51..8efb38b7a5 100644 --- a/docs/chain/sync-chain.md +++ b/docs/applications/chain.md @@ -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 diff --git a/docs/applications/node.md b/docs/applications/node.md new file mode 100644 index 0000000000..bca18454dc --- /dev/null +++ b/docs/applications/node.md @@ -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. diff --git a/docs/wallet/create-wallet.md b/docs/applications/wallet.md similarity index 87% rename from docs/wallet/create-wallet.md rename to docs/applications/wallet.md index e81bac310a..96be8f2225 100644 --- a/docs/wallet/create-wallet.md +++ b/docs/applications/wallet.md @@ -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 diff --git a/website/sidebars.json b/website/sidebars.json index 9436c4d476..553a7fe401 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -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"] } }