A recipe-driven guide to writing transaction manifests — machine-readable JSON descriptions of multi-UTXO protocols on Bitcoin and Liquid, backed by SimplicityHL covenants.
📖 Read it online: https://stringhandler.github.io/tx_manifest_book/
This is an mdBook. It is a cookbook in the style of the Rust Cookbook: a sequence of small, self-contained recipes, each solving one concrete problem and introducing one or two new concepts, building toward a full peer-to-peer lending protocol.
⚠️ Work in progress. The getting-started chapters, the first recipes, and the appendix are complete; several later recipes (05–10) and the lending walkthrough are still stubs being filled in.
You need mdBook:
cargo install mdbookThen, from this directory:
mdbook serve --open # live-reloading preview at http://localhost:3000
mdbook build # render static HTML into ./bookThe recipes are executed with the tx-manifest-wallet CLI (this book aliases it
to txw). See the Setup chapter for the install
options: the Blockstream Simplicity codespace
(preinstalled), a prebuilt release binary,
the asdf plugin, or
building from source.
| Project | What it is |
|---|---|
txmanifest-wallet |
The reference wallet/engine (tx-manifest-wallet) and example manifests. |
tx_manifest_spec |
The authoritative specification (Spec.md). When the book and the spec disagree, the spec wins. |
asdf-tx-manifest-wallet |
asdf plugin that installs prebuilt wallet binaries. |
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE)
- MIT license (LICENSE-MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.