utreexod

utreexod is a full node bitcoin implementation written in Go to showcase utreexo accumulators.

This project is currently under active development and is in a beta state. Using it for anything other than development and testing is not recommended.

Requirements

Go 1.17 or newer.

Installation

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

Linux/BSD/MacOSX/POSIX - Build from Source

• Install Go according to the installation instructions here: http://golang.org/doc/install

• Ensure Go was installed properly and is a supported version:

$ go version
$ go env GOROOT GOPATH

NOTE: The GOROOT and GOPATH above must not be the same path. It is recommended that GOPATH is set to a directory in your home directory such as ~/goprojects to avoid write permission issues. It is also recommended to add $GOPATH/bin to your PATH at this point.

• Run the following commands to obtain utreexod, all dependencies, and install it:

$ cd $GOPATH/src/github.com/utreexo/utreexod
$ go install -v . ./cmd/...

• utreexod (and utilities) will now be installed in $GOPATH/bin. If you did not already add the bin directory to your system path during Go installation, we recommend you do so now.

Getting Started

As there aren't any utreexo bridge nodes up and running for utreexo nodes to connect to, you must run your own bridge node.

$ ./utreexod --flatutreexoproofindex

Then you can connect your utreexo node to the bridge node.

# flag --utreexo must be given. If it is not given, the node will run like a normal bitcoin node.
$ ./utreexod --utreexo --connect=ip_of_the_bridge_node

Updating

Linux/BSD/MacOSX/POSIX - Build from Source

• Run the following commands to update btcd, all dependencies, and install it:

$ cd $GOPATH/src/github.com/utreexo/utreexod
$ git pull
$ go install -v . ./cmd/...

IRC

• irc.libera.chat
• channel #utreexo
• webchat

Issue Tracker

The integrated github issue tracker is used for this project.

License

utreexod is licensed under the copyfree ISC License.