Documentation ¶
Overview ¶
Copyright (c) 2018-2019 The kaspanet developers Copyright (c) 2013-2018 The btcsuite developers Copyright (c) 2015-2016 The Decred developers Copyright (c) 2013-2014 Conformal Systems LLC. Use of this source code is governed by an ISC license that can be found in the LICENSE file.
Kaspad is a full-node kaspa implementation written in Go.
The default options are sane for most users. This means kaspad 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.
Usage:
kaspad [OPTIONS]
For an up-to-date help message:
kaspad --help
The long form of all option flags (except -C) can be specified in a configuration file that is automatically parsed when kaspad starts up. By default, the configuration file is located at ~/.kaspad/kaspad.conf on POSIX-style operating systems and %LOCALAPPDATA%\kaspad\kaspad.conf on Windows. The -C (--configfile) flag can be used to override this location.
Directories ¶
Path | Synopsis |
---|---|
Package addressmanager implements concurrency safe Kaspa address manager.
|
Package addressmanager implements concurrency safe Kaspa address manager. |
Package blockdag implements kaspa block handling and DAG selection rules.
|
Package blockdag implements kaspa block handling and DAG selection rules. |
indexers
Package indexers implements optional block DAG indexes.
|
Package indexers implements optional block DAG indexes. |
cmd
|
|
Package dagconfig defines DAG configuration parameters.
|
Package dagconfig defines DAG configuration parameters. |
Package database provides a database for kaspad.
|
Package database provides a database for kaspad. |
Package domainmessage implements the kaspa domainmessage protocol.
|
Package domainmessage implements the kaspa domainmessage protocol. |
Package logs defines an interface and default implementation for subsystem logging.
|
Package logs defines an interface and default implementation for subsystem logging. |
Package mempool provides a policy-enforced pool of unmined kaspa transactions.
|
Package mempool provides a policy-enforced pool of unmined kaspa transactions. |
client
Package client implements a websocket-enabled kaspa JSON-RPC client.
|
Package client implements a websocket-enabled kaspa JSON-RPC client. |
model
Package model provides primitives for working with the kaspa JSON-RPC API.
|
Package model provides primitives for working with the kaspa JSON-RPC API. |
Package txscript implements the kaspa transaction script language.
|
Package txscript implements the kaspa transaction script language. |
Package util provides kaspa-specific convenience functions and types.
|
Package util provides kaspa-specific convenience functions and types. |
bech32
Package bech32 provides a Go implementation of the bech32 format.
|
Package bech32 provides a Go implementation of the bech32 format. |
daghash
Package daghash provides abstracted hash functionality.
|
Package daghash provides abstracted hash functionality. |
txsort
Package txsort provides the transaction sorting compatible with BIP 69.
|
Package txsort provides the transaction sorting compatible with BIP 69. |