README
¶
soterd
soterd is a full soter node implementation written in Go (golang). It started as a fork of the btcd project, where development focus has changed from providing a bitcoin node to providing an implementation of blockdag for soter.
The intent of this project is for it to act as a component in Soteria's Trade Anything Platform (TAP); a pillar of Soteria's Self Sustainable Decentralized Economy vision (SSDE).
This project is currently under active development and is in an Alpha state. It can be considered unstable and has not been in production use as of April 2019.
For beginners in blockdag/blockchain technology
The Intro to Soter BlockDAG document describes what blockdag is, and how soter/blockdag is different from bitcoin/blockchain.
For software developers
The Developers Intro document describes the capabilities of soterd, installation and updates, and links to the developer resources.
Testnet Status
The current Testnet (testnet1) will get frequent update in terms of code and genesis block. (could be as frequent as multiple times a day) So if you are running a full node for testnet1, please keep this in mind :-).
Documentation
Project documentation is located in the docs folder.
Issue Tracker
The integrated github issue tracker is used for this project.
Other soteria projects
- soterwallet - for making or receiving payments with soterd and the soter network. See the Wallet section for a note about its current functionality.
- soterdash - a web ui that provides information about the soter network.
License
soterd is licensed under the copyfree ISC License.
Documentation
¶
Overview ¶
soterd is a full-node Block DAG implementation written in Go.
The default options are sane for most users. This means soterd 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 soterd starts up. By default, the configuration file is located at ~/.soterd/soterd.conf on POSIX-style operating systems and %LOCALAPPDATA%\soterd\soterd.conf on Windows. The -C (--configfile) flag, as shown below, can be used to override this location.
Usage:
soterd [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.
-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: 8333, testnet: 5070)
--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: 8334, testnet: 5071)
--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)
--rpcquirks Mirror some JSON-RPC quirks of Bitcoin Core -- NOTE:
Discouraged unless interoperability issues need to
be worked around
--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
--regtest Use the regression test network
--simnet Use the simulation test network
--addcheckpoint= Add a custom checkpoint. Format: '<height>:<hash>'
--nocheckpoints Disable built-in checkpoints. Don't do this unless
you know what you're doing.
--uacomment= Comment to add to the user agent --
See BIP 14 for more information.
--dbtype= Database backend to use for the Block Chain (ffldb)
--profile= Enable HTTP profiling on given port -- NOTE port
must be between 1024 and 65536
--cpuprofile= Write CPU profile to the specified file
-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 SOTO/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
(100)
--generate Generate (mine) soter tokens 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 (750000)
--blockprioritysize= Size in bytes for high-priority/low-fee transactions
when creating a block (50000)
--nopeerbloomfilters Disable bloom filtering support.
--nocfilters Disable committed filtering (CF) support.
--sigcachemaxsize= The maximum number of entries in the signature
verification cache.
--blocksonly Do not accept transactions from remote peers.
--relaynonstd Relay non-standard transactions regardless of the
default settings for the active network.
--rejectnonstd Reject non-standard transactions regardless of the
default settings for the active network.
Help Options:
-h, --help Show this help message
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package addrmgr implements concurrency safe soter address manager.
|
Package addrmgr implements concurrency safe soter address manager. |
|
Package blockchain implements bitcoin block handling and chain selection rules.
|
Package blockchain implements bitcoin block handling and chain selection rules. |
|
fullblocktests
Package fullblocktests provides a set of block consensus validation tests.
|
Package fullblocktests provides a set of block consensus validation tests. |
|
indexers
Package indexers implements optional block chain indexes.
|
Package indexers implements optional block chain indexes. |
|
Package blockdag implements soter block handling and chain selection rules.
|
Package blockdag implements soter block handling and chain selection rules. |
|
Package chaincfg defines chain configuration parameters.
|
Package chaincfg defines chain configuration parameters. |
|
chainhash
Package chainhash provides abstracted hash functionality.
|
Package chainhash provides abstracted hash functionality. |
|
cmd
|
|
|
Package connmgr implements a generic Soter network connection manager.
|
Package connmgr implements a generic Soter network connection manager. |
|
Package database provides a block and metadata storage database.
|
Package database provides a block and metadata storage database. |
|
ffldb
Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage.
|
Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage. |
|
internal/treap
Package treap implements a treap data structure that is used to hold ordered key/value pairs using a combination of binary search tree and heap semantics.
|
Package treap implements a treap data structure that is used to hold ordered key/value pairs using a combination of binary search tree and heap semantics. |
|
rpctest
Package rpctest provides a soterd-specific RPC testing harness crafting and executing integration tests by driving a `soterd` instance via the `RPC` interface.
|
Package rpctest provides a soterd-specific RPC testing harness crafting and executing integration tests by driving a `soterd` instance via the `RPC` interface. |
|
Package mempool provides a policy-enforced pool of unmined soter transactions.
|
Package mempool provides a policy-enforced pool of unmined soter transactions. |
|
Package netsync implements a concurrency safe block syncing protocol.
|
Package netsync implements a concurrency safe block syncing protocol. |
|
Package peer provides a common base for creating and managing network peers.
|
Package peer provides a common base for creating and managing network peers. |
|
Package rpcclient implements a websocket-enabled soter JSON-RPC client.
|
Package rpcclient implements a websocket-enabled soter JSON-RPC client. |
|
Package soterec implements support for the elliptic curves needed for soter.
|
Package soterec implements support for the elliptic curves needed for soter. |
|
Package soterjson provides primitives for working with the soter JSON-RPC API.
|
Package soterjson provides primitives for working with the soter JSON-RPC API. |
|
Package soterlog defines an interface and default implementation for subsystem logging.
|
Package soterlog defines an interface and default implementation for subsystem logging. |
|
Package soterutil provides soter-specific convenience functions and types.
|
Package soterutil provides soter-specific convenience functions and types. |
|
base58
Package base58 provides an API for working with modified base58 and Base58Check encodings.
|
Package base58 provides an API for working with modified base58 and Base58Check encodings. |
|
bech32
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173.
|
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173. |
|
gcs
Package gcs provides an API for building and using a Golomb-coded set filter.
|
Package gcs provides an API for building and using a Golomb-coded set filter. |
|
hdkeychain
Package hdkeychain provides an API for soter hierarchical deterministic extended keys (BIP0032).
|
Package hdkeychain provides an API for soter hierarchical deterministic extended keys (BIP0032). |
|
txsort
Package txsort provides the transaction sorting according to BIP 69.
|
Package txsort provides the transaction sorting according to BIP 69. |
|
Package txscript implements the soter transaction script language.
|
Package txscript implements the soter transaction script language. |
|
Package wire implements the soter wire protocol.
|
Package wire implements the soter wire protocol. |
Click to show internal directories.
Click to hide internal directories.