exccd

README

exccd

exccd is a ExchangeCoin full node implementation written in Go (golang).

This acts as a chain daemon for the ExchangeCoin cryptocurrency. The exccd maintains the entire past transactional ledger of ExchangeCoin and allows relaying of transactions to other ExchangeCoin nodes across the world. To read more about ExchangeCoin please see the [project documentation](https://excc.co.

Note: To send or receive funds and join Proof-of-Stake mining, you will also need exccwallet.

This project is currently under active development and is in a Beta state.

It is forked from dcrd which is a Decred full node implementation written in Go. dcrd is a ongoing project under active development.

Requirements

Go >= 1.18

Getting Started

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

Updating

Windows

Install a newer MSI

Linux/BSD/MacOSX/POSIX - Build from Source

Getting the source:

For a first time installation, the project and dependency sources can be obtained manually with git and dep (create directories as needed):

git clone https://github.com/EXCCoin/exccd
cd exccd
go install . ./cmd/...

To update an existing source tree, pull the latest changes and install the matching dependencies:

git pull
go install . ./cmd/...

Tests

All tests and linters may be run in a docker container using the script run_tests.sh. This script defaults to using the current supported version of go. You can run it with the major version of Go you would like to use as the only argument to test a previous on a previous version of Go (generally ExchangeCoin supports the current version of Go and the previous one). The script requires GOPATH to be set.

./run_tests.sh 1.9

To run the tests locally without docker:

go test ./...

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

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

License

exccd is licensed under the copyfree ISC License.

Documentation

Overview

dcrd is a full-node Decred implementation written in Go.

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

Usage:

dcrd [OPTIONS]

Application Options:

-V, --version                Display version information and exit
-A, --appdata=               Path to application home directory
-C, --configfile=            Path to configuration file
-b, --datadir=               Directory to store data
    --logdir=                Directory to log output
    --nofilelogging=         Disable file logging
    --dbtype=                Database backend to use for the block chain
                             (default: 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
    --testnet                Use the test network
    --simnet                 Use the simulation test network
    --regnet                 Use the regression test network
-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)
    --sigcachemaxsize=       The maximum number of entries in the signature
                             verification cache (default: 100000)
    --utxocachemaxsize=      The maximum size in MiB of the utxo cache
                             (default: 150, minimum: 25, maximum: 32768)
    --norpc                  Disable built-in RPC server -- NOTE: The RPC
                             server is disabled by default if no
                             rpcuser/rpcpass or rpclimituser/rpclimitpass is
                             specified
    --rpclisten=             Add an interface/port to listen for RPC
                             connections (default port: 9109, testnet: 19109)
-u, --rpcuser=               Username for RPC connections
-P, --rpcpass=               Password for RPC connections
    --rpclimituser=          Username for limited RPC connections
    --rpclimitpass=          Password for limited RPC connections
    --rpccert=               File containing the certificate file
    --rpckey=                File containing the certificate key
    --tlscurve=              Curve to use when generating the TLS keypair
                             (default: P-256)
    --altdnsnames            Specify additional dns names to use when
                             generating the rpc server certificate
                             [supports DCRD_ALT_DNSNAMES environment variable]
    --notls                  Disable TLS for the RPC server -- NOTE: This is
                             only allowed if the RPC server is bound to
                             localhost
    --rpcmaxclients=         Max number of RPC clients for standard
                             connections (default: 10)
    --rpcmaxwebsockets=      Max number of RPC websocket connections (default:
                             25)
    --rpcmaxconcurrentreqs=  Max number of concurrent RPC requests that may be
                             processed concurrently (default: 20)
    --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
-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: 9108, testnet:
                             19108)
    --maxsameip=             Max number of connections with the same IP -- 0
                             to disable (default: 5)
    --maxpeers=              Max number of inbound and outbound peers
                             (default: 125)
    --dialtimeout=           How long to wait for TCP connection completion
                             Valid time units are {s, m, h}  Minimum 1 second
                             (default: 30s)
    --peeridletimeout        The duration of inactivity before a peer is timed
                             out. Valid time units are {s,m,h}. Minimum 15
                             seconds (default: 2m0s)
    --noseeders              Disable seeding for peer discovery
    --nodnsseed              DEPRECATED: use --noseeders
    --externalip=            Add an ip to the list of local addresses we claim
                             to listen on to peers
    --nodiscoverip           Disable automatic network address discovery of
                             local external IPs
    --upnp                   Use UPnP to map our listening port outside of NAT
    --nobanning              Disable banning of misbehaving peers
    --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)
    --whitelist=             Add an IP network or IP that will not be banned.
                             (eg. 192.168.1.0/24 or ::1)
    --nocheckpoints          Disable built-in checkpoints.  Don't do this
                             unless you know what you're doing
    --dumpblockchain=        Write blockchain as a flat file of blocks for use
                             with addblock, to the specified filename
    --assumevalid=           Hash of an assumed valid block. Defaults to the
                             hard-coded assumed valid block that is updated
                             periodically with new releases. Don't use a
                             different hash unless you understand the
                             implications. Set to 0 to disable
    --minrelaytxfee=         The minimum transaction fee in DCR/kB to be
                             considered a non-zero fee (default: 0.0001)
    --limitfreerelay=        Limit relay of transactions with no transaction
                             fee to the given amount in thousands of bytes per
                             minute (default: 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 (default: 100)
    --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
    --allowoldvotes          Enable the addition of very old votes to the
                             mempool
    --generate               Generate (mine) coins 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=          Minimum block size in bytes to be used when
                             creating a block
    --blockmaxsize=          Maximum block size in bytes to be used when
                             creating a block (default: 375000)
    --blockprioritysize=     Size in bytes for high-priority/low-fee
                             transactions when creating a block (default:
                             20000)
    --miningtimeoffset=      Offset the mining timestamp of a block by this
                             many seconds (positive values are in the past)
    --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
    --allowunsyncedmining    Allow block templates to be generated even when
                             the chain is not considered synced on networks
                             other than the main network.  This is
                             automatically enabled when the simnet option is
                             set.  Don't do this unless you know what you're
                             doing
    --txindex                Maintain a full hash-based transaction index
                             which makes all transactions available via the
                             getrawtransaction RPC
    --droptxindex            Deletes the hash-based transaction index from the
                             database on start up and then exits
    --addrindex              Maintain a full address-based transaction index
                             which makes the searchrawtransactions RPC
                             available
    --dropaddrindex          Deletes the address-based transaction index from
                             the database on start up and then exits
    --noexistsaddrindex      Disable the exists address index, which tracks
                             whether or not an address has even been used
    --dropexistsaddrindex    Deletes the exists address index from the
                             database on start up and then exits
    --piperx=                File descriptor of read end pipe to enable parent
                             -> child process communication
    --pipetx=                File descriptor of write end pipe to enable
                             parent <- child process communication
    --lifetimeevents         Send lifetime notifications over the TX pipe

Help Options:

-h, --help                   Show this help message