btcd

README

btcd-derived code

WARNING: this particular repository has nothing to do with Bitcoin. It's been heavily modified!

btcd 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:

-V, --version            Display version information and exit
-C, --configfile=        Path to configuration file
-b, --datadir=           Directory to store data
-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: 8108, testnet: 18108)
    --maxpeers=          Max number of inbound and outbound peers (125)
    --banduration=       How long to ban misbehaving peers.  Valid time units
                         are {s, m, h}.  Minimum 1 second (24h0m0s)
-u, --rpcuser=           Username for RPC connections
-P, --rpcpass=           Password for RPC connections
    --rpclisten=         Add an interface/port to listen for RPC connections
                         (default port: 8384, testnet: 18334)
    --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 clients for standard connections
                         (25)
    --norpc              Disable built-in RPC server -- NOTE: The RPC server
                         is disabled by default if no rpcuser/rpcpass 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
    --tor=               Specifies the proxy server used is a Tor node
    --testnet=           Use the test network
    --regtest=           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 (leveldb)
    --profile=           Enable HTTP profiling on given port -- NOTE port must
                         be between 1024 and 65536 (6060)
    --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
    --limitfreerelay=    Limit relay of transactions with no transaction fee
                         to the given amount in thousands of bytes per minute
                         (15)

    --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 (750000)
    --blockprioritysize= Size in bytes for high-priority/low-fee transactions
                         when creating a block (50000)
    --getworkkey=        DEPRECATED -- Use the --miningaddr option instead
    --addrindex=         Build and maintain a full address index. Currently
                         only supported by leveldb.
    --dropaddrindex=     Deletes the address-based transaction index from the
                         database on start up, and the exits.

Help Options:

-h, --help           Show this help message

Index

• Constants
• Variables
• func AppDataDir(appName string, roaming bool) string
• func DirBlockLocatorFromHash(hash *wire.ShaHash) blockchain.BlockLocator
• func LatestDirBlockLocator() (blockchain.BlockLocator, error)
• func NewTLSCertPair(organization string, validUntil time.Time, extraHosts []string) (cert, key []byte, err error)
• func Start_btcd(ldb database.Db, inMsgQ chan wire.FtmInternalMsg, ...)
• type MruInventoryMap
  • func NewMruInventoryMap(limit uint) *MruInventoryMap
  • func (m *MruInventoryMap) Add(iv *wire.InvVect)
  • func (m *MruInventoryMap) Delete(iv *wire.InvVect)
  • func (m *MruInventoryMap) Exists(iv *wire.InvVect) bool
  • func (m MruInventoryMap) String() string
• type NAT
  • func Discover() (nat NAT, err error)

Constants

const (
	// We need the version for webservices, and the limit should not be the version
	// anyway.
	ProtocolVersion = 1005 // version starts from 1000 for Factom

)

Variables

var (
	// ErrTorInvalidAddressResponse indicates an invalid address was
	// returned by the Tor DNS resolver.
	ErrTorInvalidAddressResponse = errors.New("invalid address response")

	// ErrTorInvalidProxyResponse indicates the Tor proxy returned a
	// response in an unexpected format.
	ErrTorInvalidProxyResponse = errors.New("invalid proxy response")

	// ErrTorUnrecognizedAuthMethod indicates the authentication method
	// provided is not recognized.
	ErrTorUnrecognizedAuthMethod = errors.New("invalid proxy authentication method")
)

var (
	ClientOnly bool
)

var (
	// ErrBadParamsField describes an error where the parameters JSON
	// field cannot be properly parsed.
	ErrBadParamsField = errors.New("bad params field")
)

Errors

var ErrClientQuit = errors.New("client quit")

ErrClientQuit describes the error where a client send is not processed due to the client having already been disconnected or dropped.

var ErrRescanReorg = btcjson.Error{
	Code:    btcjson.ErrDatabase.Code,
	Message: "Reorganize",
}

ErrRescanReorg defines the error that is returned when an unrecoverable reorganize is detected during a rescan.

Functions

func AppDataDir

func AppDataDir(appName string, roaming bool) string

AppDataDir returns an operating system specific directory to be used for storing application data for an application.

The appName parameter is the name of the application the data directory is being requested for. This function will prepend a period to the appName for POSIX style operating systems since that is standard practice. An empty appName or one with a single dot is treated as requesting the current directory so only "." will be returned. Further, the first character of appName will be made lowercase for POSIX style operating systems and uppercase for Mac and Windows since that is standard practice.

The roaming parameter only applies to Windows where it specifies the roaming application data profile (%APPDATA%) should be used instead of the local one (%LOCALAPPDATA%) that is used by default.

Example results:

dir := AppDataDir("myapp", false)
 POSIX (Linux/BSD): ~/.myapp
 Mac OS: $HOME/Library/Application Support/Myapp
 Windows: %LOCALAPPDATA%\Myapp
 Plan 9: $home/myapp

func DirBlockLocatorFromHash

func DirBlockLocatorFromHash(hash *wire.ShaHash) blockchain.BlockLocator

DirBlockLocatorFromHash returns a block locator for the passed block hash. See BlockLocator for details on the algotirhm used to create a block locator.

In addition to the general algorithm referenced above, there are a couple of special cases which are handled:

• If the genesis hash is passed, there are no previous hashes to add and therefore the block locator will only consist of the genesis hash
• If the passed hash is not currently known, the block locator will only consist of the passed hash

func LatestDirBlockLocator

func LatestDirBlockLocator() (blockchain.BlockLocator, error)

LatestDirBlockLocator returns a block locator for the latest known tip of the main (best) chain.

func NewTLSCertPair

func NewTLSCertPair(organization string, validUntil time.Time, extraHosts []string) (cert, key []byte, err error)

NewTLSCertPair returns a new PEM-encoded x.509 certificate pair based on a 521-bit ECDSA private key. The machine's local interface addresses and all variants of IPv4 and IPv6 localhost are included as valid IP addresses.

func Start_btcd

func Start_btcd(
	ldb database.Db,
	inMsgQ chan wire.FtmInternalMsg,
	outMsgQ chan wire.FtmInternalMsg,
	inCtlMsgQ chan wire.FtmInternalMsg,
	outCtlMsgQ chan wire.FtmInternalMsg,
	user, pass string, clientMode bool)

Types

type MruInventoryMap

type MruInventoryMap struct {
	// contains filtered or unexported fields
}

MruInventoryMap provides a map that is limited to a maximum number of items with eviction for the oldest entry when the limit is exceeded.

func NewMruInventoryMap

func NewMruInventoryMap(limit uint) *MruInventoryMap

NewMruInventoryMap returns a new inventory map that is limited to the number of entries specified by limit. When the number of entries exceeds the limit, the oldest (least recently used) entry will be removed to make room for the new entry.

func (*MruInventoryMap) Add

func (m *MruInventoryMap) Add(iv *wire.InvVect)

Add adds the passed inventory to the map and handles eviction of the oldest item if adding the new item would exceed the max limit.

func (*MruInventoryMap) Delete

func (m *MruInventoryMap) Delete(iv *wire.InvVect)

Delete deletes the passed inventory item from the map (if it exists).

func (*MruInventoryMap) Exists

func (m *MruInventoryMap) Exists(iv *wire.InvVect) bool

Exists returns whether or not the passed inventory item is in the map.

func (MruInventoryMap) String

func (m MruInventoryMap) String() string

String returns the map as a human-readable string.

type NAT

type NAT interface {
	// Get the external address from outside the NAT.
	GetExternalAddress() (addr net.IP, err error)
	// Add a port mapping for protocol ("udp" or "tcp") from externalport to
	// internal port with description lasting for timeout.
	AddPortMapping(protocol string, externalPort, internalPort int, description string, timeout int) (mappedExternalPort int, err error)
	// Remove a previously added port mapping from externalport to
	// internal port.
	DeletePortMapping(protocol string, externalPort, internalPort int) (err error)
}

NAT is an interface representing a NAT traversal options for example UPNP or NAT-PMP. It provides methods to query and manipulate this traversal to allow access to services.

func Discover

func Discover() (nat NAT, err error)

Discover searches the local network for a UPnP router returning a NAT for the network if so, nil if not.