|
1 | | -# Rust Bitcoin |
| 1 | +# Introduction |
2 | 2 |
|
3 | | -[![CC0 1.0][cc-shield]][cc] |
| 3 | +This book is created and maintained by those involved in the |
| 4 | +[`rust-bitcoin`](https://github.com/rust-bitcoin) GitHub organization, contributions are |
| 5 | +appreciated. It covers various crates from the org and as such, aims to be useful to developers |
| 6 | +wanting to write code in Rust that interacts with the Bitcoin network. It is specifically not |
| 7 | +limited to just the [`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) crate, although |
| 8 | +that is a good starting point if you want a one-stop-shop for interacting with Bitcoin in Rust. |
4 | 9 |
|
5 | | -[`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) is a library for working with Bitcoin in Rust. |
6 | | -It contains Bitcoin network protocol and associated primitives. |
7 | | -You can find more by reading the [documentation](https://docs.rs/bitcoin). |
| 10 | +There are a number of good libraries outside of the `rust-bitcoin` organization that use the crates |
| 11 | +covered here, two that you might like to check out are: |
8 | 12 |
|
9 | | -To add `rust-bitcoin` to your project, run: |
| 13 | +- [`Bitcoin Dev Kit`](https://bitcoindevkit.org/) |
| 14 | +- [`Lightning Dev Kit`](https://lightningdevkit.org/) |
10 | 15 |
|
11 | | -```bash |
12 | | -cargo add bitcoin |
13 | | -``` |
14 | | - |
15 | | -Additionally, you can add flags to enable features. |
16 | | -Here's an example: |
17 | | - |
18 | | -```bash |
19 | | -cargo add bitcoin --features=rand-std |
20 | | -``` |
21 | | - |
22 | | -This cookbook provides straightforward examples that showcase effective approaches |
23 | | -for accomplishing typical Bitcoin-related programming tasks, |
24 | | -and utilizing the Rust ecosystem's crates. |
25 | | - |
26 | | -The book covers various topics, including receiving data over P2P, |
27 | | -parsing blocks and transactions, |
28 | | -and constructing and signing transactions. |
| 16 | +Finally, this book is currently a work inn progress but hopes to eventually cover various topics, |
| 17 | +including parsing blocks and transactions, constructing and signing transactions, receiving data |
| 18 | +over the peer-to-peer network, plus fun stuff you can do with miniscript. |
29 | 19 |
|
30 | 20 | ## Table of Contents |
31 | 21 |
|
32 | | -This book contains: |
33 | | - |
| 22 | +1. [Getting Started](getting_started.md) |
34 | 23 | 1. [Constructing and Signing Transactions](tx.md) |
35 | 24 | 1. [SegWit V0](tx_segwit-v0.md) |
36 | 25 | 1. [Taproot](tx_taproot.md) |
|
0 commit comments