utreexod ====

utreexod is a full node bitcoin implementation with support for utreexo accumulators. Utreexo accumulator is an append only merkle forest data structure with support for deleting elements from the set. More information at Utreexo library github repository

The main features over a traditional node are:

• Immediate node bootstrap by having the UTXO state hardcoded into the codebase.
• Uses a tiny amount of memory.
• Extremely low disk i/o needed compared to a traditional node. Will not wear out micro sd cards.

This project is currently under active development and is in a beta state. Using it on mainnet for anything other than negligible amounts of bitcoin is not recommended.

Requirements

Go 1.25 or newer.

Rust 1.81.0 or newer (To compile the built in BDK wallet support).

Installation

https://github.com/utreexo/utreexod/

Linux/MacOSX - Build from Source

To build with BDK wallet:

make all

To build without the BDK wallet:

go build -o . ./...

To build and install binaries to $GOPATH/bin with BDK wallet:

make install

Getting Started

To run a utreexo node:

# The node will start from the hardcoded UTXO state and skip the initial block download.
If the node was built with the bdk wallet, it'll start with the bdk wallet enabled.
./utreexod
For utreexo archival nodes that will not skip the initial block download.
./utreexod --noassumeutreexo --prune=0
To disable the bdkwallet. NOTE: the wallet will not be disabled if the node had ever
started up with the wallet enabled.
./utreexod --nobdkwallet

To use the built in bdk wallet:

# Show the mnemonic word list of the wallet.
./utreexoctl getmnemonicwords
Get a fresh address from the wallet.
./utreexoctl freshaddress
Get an address that has not received funds yet from the wallet.
./utreexoctl unusedaddress
Get an address at the desired index.
./utreexoctl peekaddress "bip32-index"
Example: Returns the address at index 100.
./utreexoctl peekaddress 100
Get the current balance of the wallet.
./utreexoctl balance
List all the relevant transactions for the wallet.
./utreexoctl listbdktransactions
List all the relevant utxos that the wallet controls.
./utreexoctl listbdkutxos
Create a transaction from the wallet.
./utreexoctl createtransactionfrombdkwallet "feerate_in_sat_per_vbyte" '[{"amount":n,"address":"value"},...]'
Example: feerate of 1 satoshi per vbyte, sending 10,000sats to address tb1pdt9hl8ymdetdmvgk54aft8jaq4xle998m8e6adwxs4vh7vwpl9jsyadlhq
./utreexoctl createtransactionfrombdkwallet 1 '[{"amount":10000,"address":"tb1pdt9hl8ymdetdmvgk54aft8jaq4xle998m8e6adwxs4vh7vwpl9jsyadlhq"}]'
Example: feerate of 12 satoshi per vbyte, sending 10,000sats and 20,000sats to two addresses
./utreexoctl createtransactionfrombdkwallet 12 '[{"amount":10000,"address":"tb1pdt9hl8ymdetdmvgk54aft8jaq4xle998m8e6adwxs4vh7vwpl9jsyadlhq"},{"amount":20000,"address":"tb1puuv30z568uc58c40duwl5ytyu5898fyehlyqtm0al2xk70z8tw0qcxfn6w"}]'

Bridge node

Bridge nodes are nodes that keep the entire merkle forest and attach proofs to new blocks and transactions. Since miners and nodes publish blocks and transactions without proofs, these nodes are needed to allow for utreexo nodes without a soft fork.

Note: bridge nodes currently need to generate proofs for all historical blocks during the initial sync, which is slow. There are known ways to speed this up significantly but they could not be included in this release (v0.5.0).

# Either one will work. The only difference these have is that the flatutreexoproofindex
stores all the data in .dat files instead of leveldb. It makes it easier to read the
proofs for tinkering.
./utreexod --flatutreexoproofindex
./utreexod --utreexoproofindex
For running bridge nodes that also keep all historical block data.
./utreexod --flatutreexoproofindex --prune=0
./utreexod --utreexoproofindex --prune=0

Community

Discord

Issue Tracker

The integrated github issue tracker is used for this project.

License

utreexod is licensed under the copyfree ISC License.