feat: cookbook

Cookbook on how to sign segwit and taproot transactions

Additionally:

- Convert `build.sh` to a GitHub Action
- Automated CI in GitHub Actions that test all the code in the cookbook
- Automated scheduled CI in GitHub Actions that check all markdown files for broken links
- Dependabot to update (weekly)
  - GitHub Actions
  - Test dependencies
- `justfile` to easy run the build and test with `just`

Author: realeinherjar

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+  - package-ecosystem: "cargo"
+    directory: "/cookbook/tests" # point this towards a Cargo.toml directory
+    schedule:
+      # Check for updates to Rust dependencies every week
+      interval: "weekly"

.github/workflows/check-links.yml

@@ -0,0 +1,25 @@
+name: Markdown Links Check
+# runs every monday at 9 am
+on:
+  schedule:
+    - cron: "0 9 * * 1"
+  workflow_dispatch: null
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        # checks all markdown files from /cookbook including all subfolders
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          folder-path: 'cookbook/'
+      - uses: actions/checkout@v4
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        # checks all markdown files from root but ignores subfolders
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          max-depth: 0

.github/workflows/gh-pages.yml

@@ -0,0 +1,44 @@
+# This needs the following setting:
+# Setttings > Actions > General > Workflow permissions
+# change to "Read and write permissions"
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch: null
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true # could be useful in the future
+          fetch-depth: 0   # we just need the latest commit
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: 'latest'
+
+      - name: Build mdbook
+        working-directory: ./cookbook
+        run: mdbook build --dest-dir "../site/static/book"
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: "latest"
+
+      - name: Build Hugo
+        working-directory: ./site
+        run: hugo --minify
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/master'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site/public

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Tests
+on:
+  push:
+    branches: [ master, '[0-9]+.[0-9]+.[0-9]+', '[0-9]+.[0-9]+.[0-9]+-[A-Za-z0-9]+' ]
+  pull_request:
+    branches: [ master, '[0-9]+.[0-9]+.[0-9]+', '[0-9]+.[0-9]+.[0-9]+-[A-Za-z0-9]+' ]
+# runs every monday at 9 am
+  schedule:
+    - cron: "0 9 * * 1"
+  workflow_dispatch: null
+
+jobs:
+  code-samples:
+    name: Test code samples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+      - name: Generate harness
+        working-directory: ./cookbook/tests
+        run: ./generate.sh
+      - name: Test code samples
+        working-directory: ./cookbook/tests
+        run: cargo test

.gitignore

@@ -6,4 +6,7 @@ site/.hugo_build.lock
 
 # mdbook build
 cookbook/book
+cookbook/tests/Cargo.lock
+cookbook/tests/target
+cookbook/tests/src
 site/static/book

README.md

@@ -7,3 +7,13 @@ Website for the rust-bitcoin ecosystem. The site is built using [hugo](https://g
 [nightfall](https://themes.gohugo.io/themes/hugo-theme-nightfall/) theme.
 
 Includes a cookbook built with [mdbook](https://rust-lang.github.io/mdBook/).
+
+## License
+
+This website is licensed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc].
+
+[![CC BY-SA 4.0][cc-image]][cc]
+
+[cc]: https://creativecommons.org/publicdomain/zero/1.0/
+[cc-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
+[cc-shield]: https://img.shields.io/badge/License-CC0%201.0-lightgrey.svg

build.sh

@@ -1,9 +1,58 @@
-# Rust Bitcoin CookBook
+# Rust Bitcoin Cookbook
 
-Welcome to the Rust-Bitcoin documentation! This documentation is designed to provide readers with a
-comprehensive understanding of Rust-Bitcoin and its key features.
+[![CC0 1.0][cc-shield]][cc]
 
+Welcome to the `rust-bitcoin` cookbook!
+This cookbook is designed to provide readers with a
+comprehensive understanding of `rust-bitcoin` and its key features.
+Don't forget to check [`rust-bitcoin`'s documentation](https://docs.rs/bitcoin)
 
-## Build
+## How to contribute
 
-The book can be built with `mdbook`: https://rust-lang.github.io/mdBook/
+For the cookbook we use [`mdbook`](https://rust-lang.github.io/mdBook).
+Please check how to install it on your system.
+
+To build the cookbook locally, run:
+
+```bash
+mdbook build
+```
+
+If you want to preview the cookbook locally, run:
+
+```bash
+mdbook serve
+```
+
+### Testing the code snippets
+
+Since [`mdbook` does not support external crates](https://github.com/rust-lang/mdBook/issues/706),
+we use [a solution provided by `doc-comment`](https://github.com/rust-lang/mdBook/issues/706#issuecomment-1139423009)
+to test the code snippets in the cookbook.
+First, go to the `tests/` directory:
+
+```bash
+cd tests
+```
+
+Then, run the `generate.sh` to automatically generate all tests files:
+
+```bash
+./generate.sh
+```
+
+Finally run the tests:
+
+```bash
+cargo test
+```
+
+## License
+
+This website is licensed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc].
+
+[![CC BY-SA 4.0][cc-image]][cc]
+
+[cc]: https://creativecommons.org/publicdomain/zero/1.0/
+[cc-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
+[cc-shield]: https://img.shields.io/badge/License-CC0%201.0-lightgrey.svg

cookbook/README.md

@@ -1,6 +1,17 @@
 [book]
-authors = ["Harshil Jani"]
+authors = [
+    "Harshil Jani <[email protected]>",
+    "Tobin C. Harding<[email protected]>",
+    "Einherjar <[email protected]>",
+]
 language = "en"
 multilingual = false
 src = "src"
 title = "Rust Bitcoin Cookbook"
+description = "A cookbook for Rust Bitcoin development"
+
+[rust]
+edition = "2021"
+
+[output.html.playground]
+runnable = false # playground is not runnable by default

cookbook/book.toml

@@ -1,5 +1,7 @@
 # Summary
 
-[Table of Contents](./table_of_contents.md)
-[About](./about.md)
-- [Chapter 1](./chapter_1.md)
+[Introduction](./intro.md)
+
+- [Constructing and Signing Transactions](tx.md)
+  - [SegWit V0](tx_segwit-v0.md)
+  - [Taproot](tx_taproot.md)

cookbook/src/SUMMARY.md

@@ -0,0 +1,46 @@
+# Rust Bitcoin
+
+[![CC0 1.0][cc-shield]][cc]
+
+[`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) is a library for working with Bitcoin in Rust.
+It contains Bitcoin network protocol and associated primitives.
+You can find more by reading the [documentation](https://docs.rs/bitcoin).
+
+To add `rust-bitcoin` to your project, run:
+
+```bash
+cargo add bitcoin
+```
+
+Additionally, you can add flags to enable features.
+Here's an example:
+
+```bash
+cargo add bitcoin --features=rand-std
+```
+
+This cookbook provides straightforward examples that showcase effective approaches
+for accomplishing typical Bitcoin-related programming tasks,
+and utilizing the Rust ecosystem's crates.
+
+The book covers various topics, including receiving data over P2P,
+parsing blocks and transactions,
+and constructing and signing transactions.
+
+## Table of Contents
+
+This book contains:
+
+1. [Constructing and Signing Transactions](tx.md)
+    1. [SegWit V0](tx_segwit-v0.md)
+    1. [Taproot](tx_taproot.md)
+
+## License
+
+This website is licensed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc].
+
+[![CC BY-SA 4.0][cc-image]][cc]
+
+[cc]: https://creativecommons.org/publicdomain/zero/1.0/
+[cc-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
+[cc-shield]: https://img.shields.io/badge/License-CC0%201.0-lightgrey.svg

cookbook/src/about.md

@@ -0,0 +1,6 @@
+# Constructing and Signing Transactions
+
+We provide the following examples:
+
+- [Constructing and Signing Transactions - SegWit V0](tx_segwit-v0.md)
+- [Constructing and Signing Transactions - Taproot](tx_taproot.md)