ucd

README

ucd

Utopia Overview

Utopia is a blockchain-based cryptocurrency with a strong focus on community input, open governance, and sustainable funding for development. It utilizes a hybrid proof-of-work and proof-of-stake mining system to ensure that a small group cannot dominate the flow of transactions or make changes to Utopia without the input of the community. A unit of the currency is called a utopia (UC).

https://utopia.org

Latest Downloads

https://utopia.org/downloads

What is ucd?

ucd is a full node implementation of Utopia written in Go (golang).

It acts as a fully-validating chain daemon for the Utopia cryptocurrency. ucd maintains the entire past transactional ledger of Utopia and allows relaying of transactions to other Utopia nodes around the world.

This software is currently under active development. It is extremely stable and has been in production use since February 2016.

The software was originally forked from btcd, which is a bitcoin full node implementation that is still under active development. To gain the benefit of btcd's ongoing upgrades, including improved peer and connection handling, database optimization, and other blockchain related technology improvements, ucd is continuously synced with the btcd codebase.

What is a full node?

The term 'full node' is short for 'fully-validating node' and refers to software that fully validates all transactions and blocks, as opposed to trusting a 3rd party. In addition to validating transactions and blocks, nearly all full nodes also participate in relaying transactions and blocks to other full nodes around the world, thus forming the peer-to-peer network that is the backbone of the Utopia cryptocurrency.

The full node distinction is important, since full nodes are not the only type of software participating in the Utopia peer network. For instance, there are 'lightweight nodes' which rely on full nodes to serve the transactions, blocks, and cryptographic proofs they require to function, as well as relay their transactions to the rest of the global network.

Why run ucd?

As described in the previous section, the Utopia cryptocurrency relies on having a peer-to-peer network of nodes that fully validate all transactions and blocks and then relay them to other full nodes.

Running a full node with ucd contributes to the overall security of the network, increases the available paths for transactions and blocks to relay, and helps ensure there are an adequate number of nodes available to serve lightweight clients, such as Simplified Payment Verification (SPV) wallets.

Without enough full nodes, the network could be unable to expediently serve users of lightweight clients which could force them to have to rely on centralized services that significantly reduce privacy and are vulnerable to censorship.

In terms of individual benefits, since ucd fully validates every block and transaction, it provides the highest security and privacy possible when used in conjunction with a wallet that also supports directly connecting to it in full validation mode, such as ucwallet (CLI) and Utopiaiton (GUI).

Minimum Recommended Specifications (ucd only)

• 10 GB disk space (as of September 2018, increases over time)
• 1GB memory (RAM)
• ~150MB/day download, ~1.5GB/day upload
  • Plus one-time initial download of the entire block chain
• Windows 7/8.x/10 (server preferred), macOS, Linux
• High uptime

Getting Started

So, you've decided to help the network by running a full node. Great! Running ucd is simple. All you need to do is install ucd on a machine that is connected to the internet and meets the minimum recommended specifications, and launch it.

Also, make sure your firewall is configured to allow inbound connections to port 10508.

Installing and updating

Binaries (Windows/Linux/macOS)

Binary releases are provided for common operating systems and architectures:

https://utopia.org/downloads

Build from source (all platforms)

Building or updating from source requires the following build dependencies:

• Go 1.11 or 1.12

  Installation instructions can be found here: https://golang.org/doc/install. It is recommended to add $GOPATH/bin to your PATH at this point.

• Git

  Installation instructions can be found at https://git-scm.com or https://gitforwindows.org.

To build and install from a checked-out repo, run go install . ./cmd/... in the repo's root directory. Some notes:

• Set the GO111MODULE=on environment variable if building from within GOPATH.

• The ucd executable will be installed to $GOPATH/bin. GOPATH defaults to $HOME/go (or %USERPROFILE%\go on Windows) if unset.

Example of obtaining and building from source on Windows 10:

PS> git clone https://github.com/UtopiaCoinOrg/ucd $env:USERPROFILE\src\ucd
PS> cd $env:USERPROFILE\src\ucd
PS> go install . .\cmd\...
PS> & "$(go env GOPATH)\bin\ucd" -V

Docker

Running ucd

You can run a utopia node from inside a docker container. To build the image yourself, use the following command:

docker build -t utopia/ucd .

Or you can create an alpine based image (requires Docker 17.05 or higher):

docker build -t utopia/ucd:alpine -f Dockerfile.alpine .

You can then run the image using:

docker run utopia/ucd

You may wish to use an external volume to customise your config and persist the data in an external volume:

docker run --rm -v /home/user/ucdata:/root/.ucd/data utopia/ucd

For a minimal image, you can use the utopia/ucd:alpine tag. This is typically a more secure option while also being a much smaller image.

You can run ucctl from inside the image. For example, run an image (mounting your data from externally) with:

docker run --rm -ti --name=ucd-1 -v /home/user/.ucd:/root/.ucd \
  utopia/ucd:alpine

And then run ucctl commands against it. For example:

docker exec -ti ucd-1 ucctl getbestblock

Running Tests

All tests and linters may be run in a docker (or podman) container using the script run_tests.sh by specifying either docker or podman as the first parameter. This script defaults to using the current latest supported version of Go, but it also respects the GOVERSION environment variable set to the major version of Go to allow testing on a previous version of Go. Generally, Utopia only supports the current and previous major versions of Go.

./run_tests.sh docker

To run the tests locally without docker on the latest supported version of Go:

./run_tests.sh

To run the tests locally without docker on Go 1.11:

GOVERSION=1.11 ./run_tests.sh

Contact

If you have any further questions you can find us at:

https://utopia.org/community

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

The documentation for ucd is a work-in-progress. It is located in the docs folder.

License

ucd is licensed under the copyfree ISC License.

Documentation

Overview

ucd is a full-node Utopia implementation written in Go.

The default options are sane for most users. This means ucd 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 ucd starts up. By default, the configuration file is located at ~/.ucd/ucd.conf on POSIX-style operating systems and %LOCALAPPDATA%\ucd\ucd.conf on Windows. The -C (--configfile) flag, as shown below, can be used to override this location.

Usage:

ucd [OPTIONS]

Application Options:

-V, --version             Display version information and exit
-C, --configfile=         Path to configuration file
-b, --datadir=            Directory to store data
    --logdir=             Directory to log output.
    --nofilelogging=      Disable file logging.
-a, --addpeer=            Add a peer to connect with at startup
    --connect=            Connect only to the specified peers at startup
    --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
    --listen=             Add an interface/port to listen for connections
                          (default all interfaces port: 10508, testnet: 11508)
    --maxsameip=          Max number of connections with the same IP -- 0 to
                          disable (default: 5)
    --maxpeers=           Max number of inbound and outbound peers (125)
    --nobanning           Disable banning of misbehaving peers
    --banduration=        How long to ban misbehaving peers.  Valid time units
                          are {s, m, h}.  Minimum 1 second (24h0m0s)
    --banthreshold=       Maximum allowed ban score before disconnecting and
                          banning misbehaving peers.
    --whitelist=          Add an IP network or IP that will not be banned.
                          (eg. 192.168.1.0/24 or ::1)
-u, --rpcuser=            Username for RPC connections
-P, --rpcpass=            Password for RPC connections
    --rpclimituser=       Username for limited RPC connections
    --rpclimitpass=       Password for limited RPC connections
    --rpclisten=          Add an interface/port to listen for RPC connections
                          (default port: 10509, testnet: 11509)
    --rpccert=            File containing the certificate file
    --rpckey=             File containing the certificate key
    --rpcmaxclients=      Max number of RPC clients for standard connections
                          (10)
    --rpcmaxwebsockets=   Max number of RPC websocket connections (25)
    --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
    --nodnsseed           Disable DNS seeding for peers
    --externalip=         Add an ip to the list of local addresses we claim to
                          listen on to peers
    --proxy=              Connect via SOCKS5 proxy (eg. 127.0.0.1:9050)
    --proxyuser=          Username for proxy server
    --proxypass=          Password for proxy server
    --onion=              Connect to tor hidden services via SOCKS5 proxy
                          (eg. 127.0.0.1:9050)
    --onionuser=          Username for onion proxy server
    --onionpass=          Password for onion proxy server
    --noonion             Disable connecting to tor hidden services
    --torisolation        Enable Tor stream isolation by randomizing user
                          credentials for each connection.
    --testnet             Use the test network
    --simnet              Use the simulation test network
    --regnet              Use the regression test network
    --nocheckpoints       Disable built-in checkpoints.  Don't do this unless
                          you know what you're doing.
    --dbtype=             Database backend to use for the Block Chain (ffldb)
    --profile=            Enable HTTP profiling on given [addr:]port -- NOTE: port
                          must be between 1024 and 65536
    --cpuprofile=         Write CPU profile to the specified file
    --memprofile=         Write mem profile to the specified file
    --dumpblockchain=     Write blockchain as a gob-encoded map to the
                          specified file
    --miningtimeoffset=   Offset the mining timestamp of a block by this many
                          seconds (positive values are in the past)
-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 (info)
    --upnp                Use UPnP to map our listening port outside of NAT
    --minrelaytxfee=      The minimum transaction fee in UC/kB to be
                          considered a non-zero fee.
    --limitfreerelay=     Limit relay of transactions with no transaction fee
                          to the given amount in thousands of bytes per
                          minute (15)
    --norelaypriority     Do not require free or low-fee transactions to have
                          high priority for relaying
    --maxorphantx=        Max number of orphan transactions to keep in memory
                          (1000)
    --generate            Generate (mine) bitcoins using the CPU
    --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
    --blockminsize=       Mininum block size in bytes to be used when creating
                          a block
    --blockmaxsize=       Maximum block size in bytes to be used when creating
                          a block (375000)
    --blockprioritysize=  Size in bytes for high-priority/low-fee transactions
                          when creating a block (20000)
    --nonaggressive       Disable mining off of the parent block of the blockchain
                          if there aren't enough voters
    --nominingstatesync   Disable synchronizing the mining state with other nodes
    --allowoldvotes       Enable the addition of very old votes to the mempool

    --sigcachemaxsize=    The maximum number of entries in the signature
                          verification cache.
    --blocksonly          Do not accept transactions from remote peers.
    --acceptnonstd        Accept and relay non-standard transactions to
                          the network regardless of the default settings
                          for the active network.
    --rejectnonstd        Reject non-standard transactions regardless of the
                          default settings for the active network.
    --altdnsnames:        Specify additional dns names to use when
                          generating the rpc server certificate
                          [supports UCD_ALT_DNSNAMES environment variable]

Help Options:

-h, --help           Show this help message