utreexod

README

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.

The catch is that it uses more bandwidth compared to a normal node. For block downloads it's around 1.7 times more data. For transactions the absolute worst case is 4 times more but transaction relay supports caching so it'll be a lot better.

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

Requirements

Go 1.18 or newer.

Rust 1.73.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 . ./...

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 to 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"}]'`
# feerate of 12 satoshi per vbyte, sending 10,000sats to address tb1pdt9hl8ymdetdmvgk54aft8jaq4xle998m8e6adwxs4vh7vwpl9jsyadlhq and 20,000sats to address tb1puuv30z568uc58c40duwl5ytyu5898fyehlyqtm0al2xk70z8tw0qcxfn6w
`./utreexoctl createtransactionfrombdkwallet 12 '[{"amount":10000,"address":"tb1pdt9hl8ymdetdmvgk54aft8jaq4xle998m8e6adwxs4vh7vwpl9jsyadlhq"},{"amount":20000,"address":"tb1puuv30z568uc58c40duwl5ytyu5898fyehlyqtm0al2xk70z8tw0qcxfn6w"}]'`

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. To run a bridge node:

# 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 are also archival.
`./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.

Documentation

Overview

btcd is a full-node bitcoin implementation written in Go.

The default options are sane for most users. This means btcd will work 'out of the box' for most users. However, there are also a wide variety of flags that can be used to control it.

The following section provides a usage overview which enumerates the flags. An interesting point to note is that the long form of all of these options (except -C) can be specified in a configuration file that is automatically parsed when btcd starts up. By default, the configuration file is located at ~/.btcd/btcd.conf on POSIX-style operating systems and %LOCALAPPDATA%\btcd\btcd.conf on Windows. The -C (--configfile) flag, as shown below, can be used to override this location.

Usage:

btcd [OPTIONS]

Application Options:

    --addcheckpoint=        Add a custom checkpoint.  Format:
                            '<height>:<hash>'
-a, --addpeer=              Add a peer to connect with at startup
    --addrindex             Maintain a full address-based transaction index
                            which makes the searchrawtransactions RPC
                            available
    --banduration=          How long to ban misbehaving peers.  Valid time
                            units are {s, m, h}.  Minimum 1 second (default:
                            24h0m0s)
    --banthreshold=         Maximum allowed ban score before disconnecting
                            and banning misbehaving peers. (default: 100)
    --blockmaxsize=         Maximum block size in bytes to be used when
                            creating a block (default: 750000)
    --blockminsize=         Mininum block size in bytes to be used when
                            creating a block
    --blockmaxweight=       Maximum block weight to be used when creating a
                            block (default: 3000000)
    --blockminweight=       Mininum block weight to be used when creating a
                            block
    --blockprioritysize=    Size in bytes for high-priority/low-fee
                            transactions when creating a block (default:
                            50000)
    --blocksonly            Do not accept transactions from remote peers.
-C, --configfile=           Path to configuration file
    --connect=              Connect only to the specified peers at startup
    --cpuprofile=           Write CPU profile to the specified file
-b, --datadir=              Directory to store data
    --dbtype=               Database backend to use for the Block Chain
                            (default: ffldb)
-d, --debuglevel=           Logging level for all subsystems {trace, debug,
                            info, warn, error, critical} -- You may also
                            specify
                            <subsystem>=<level>,<subsystem2>=<level>,... to
                            set the log level for individual subsystems --
                            Use show to list available subsystems (default:
                            info)
    --dropaddrindex         Deletes the address-based transaction index from
                            the database on start up and then exits.
    --dropcfindex           Deletes the index used for committed filtering
                            (CF) support from the database on start up and
                            then exits.
    --droptxindex           Deletes the hash-based transaction index from the
                            database on start up and then exits.
    --externalip=           Add an ip to the list of local addresses we claim
                            to listen on to peers
    --generate              Generate (mine) bitcoins using the CPU
    --limitfreerelay=       Limit relay of transactions with no transaction
                            fee to the given amount in thousands of bytes per
                            minute (default: 15)
    --listen=               Add an interface/port to listen for connections
                            (default all interfaces port: 8333, testnet:
                            18333, signet: 38333)
    --logdir=               Directory to log output
    --maxorphantx=          Max number of orphan transactions to keep in
                            memory (default: 100)
    --maxpeers=             Max number of inbound and outbound peers
                            (default: 125)
    --miningaddr=           Add the specified payment address to the list of
                            addresses to use for generated blocks -- At least
                            one address is required if the generate option is
                            set
    --minrelaytxfee=        The minimum transaction fee in BTC/kB to be
                            considered a non-zero fee. (default: 1e-05)
    --nobanning             Disable banning of misbehaving peers
    --nocfilters            Disable committed filtering (CF) support
    --nocheckpoints         Disable built-in checkpoints.  Don't do this
                            unless you know what you're doing.
    --nodnsseed             Disable DNS seeding for peers
    --nolisten              Disable listening for incoming connections --
                            NOTE: Listening is automatically disabled if the
                            --connect or --proxy options are used without
                            also specifying listen interfaces via --listen
    --noonion               Disable connecting to tor hidden services
    --nopeerbloomfilters    Disable bloom filtering support
    --norelaypriority       Do not require free or low-fee transactions to
                            have high priority for relaying
    --norpc                 Disable built-in RPC server -- NOTE: The RPC
                            server is disabled by default if no
                            rpcuser/rpcpass or rpclimituser/rpclimitpass is
                            specified
    --notls                 Disable TLS for the RPC server -- NOTE: This is
                            only allowed if the RPC server is bound to
                            localhost
    --onion=                Connect to tor hidden services via SOCKS5 proxy
                            (eg. 127.0.0.1:9050)
    --onionpass=            Password for onion proxy server
    --onionuser=            Username for onion proxy server
    --profile=              Enable HTTP profiling on given port -- NOTE port
                            must be between 1024 and 65536
    --proxy=                Connect via SOCKS5 proxy (eg. 127.0.0.1:9050)
    --proxypass=            Password for proxy server
    --proxyuser=            Username for proxy server
    --regtest               Use the regression test network
    --rejectnonstd          Reject non-standard transactions regardless of
                            the default settings for the active network.
    --relaynonstd           Relay non-standard transactions regardless of the
                            default settings for the active network.
    --rpccert=              File containing the certificate file
    --rpckey=               File containing the certificate key
    --rpclimitpass=         Password for limited RPC connections
    --rpclimituser=         Username for limited RPC connections
    --rpclisten=            Add an interface/port to listen for RPC
                            connections (default port: 8334, testnet: 18334)
    --rpcmaxclients=        Max number of RPC clients for standard
                            connections (default: 10)
    --rpcmaxconcurrentreqs= Max number of concurrent RPC requests that may be
                            processed concurrently (default: 20)
    --rpcmaxwebsockets=     Max number of RPC websocket connections (default:
                            25)
    --rpcquirks             Mirror some JSON-RPC quirks of Bitcoin Core --
                            NOTE: Discouraged unless interoperability issues
                            need to be worked around
-P, --rpcpass=              Password for RPC connections
-u, --rpcuser=              Username for RPC connections
    --sigcachemaxsize=      The maximum number of entries in the signature
                            verification cache (default: 100000)
    --simnet                Use the simulation test network
    --testnet               Use the test network
    --torisolation          Enable Tor stream isolation by randomizing user
                            credentials for each connection.
    --trickleinterval=      Minimum time between attempts to send new
                            inventory to a connected peer (default: 10s)
    --txindex               Maintain a full hash-based transaction index
                            which makes all transactions available via the
                            getrawtransaction RPC
    --uacomment=            Comment to add to the user agent -- See BIP 14
                            for more information.
    --upnp                  Use UPnP to map our listening port outside of NAT
-V, --version               Display version information and exit
    --whitelist=            Add an IP network or IP that will not be banned.
                            (eg. 192.168.1.0/24 or ::1)

Help Options:

-h, --help           Show this help message