cometbft

Documentation

Index

• Constants
• func AddrBookPath(chainRootDir string) string
• func NodeIDAddressString(pubkey ed25519.PubKey, hostPort string) string
• func ResetState(chainRootDir string) error
• type CometBftNode
  • func NewCometBftNode(ctx context.Context, app abciTypes.Application, conf *cometConfig.Config, ...) (*CometBftNode, error)
  • func (n *CometBftNode) IsCatchup() bool
  • func (n *CometBftNode) Start() error
  • func (n *CometBftNode) Stop() error
• type LogWrapper
  • func NewLogWrapper(log *log.Logger) *LogWrapper
  • func (lw *LogWrapper) Debug(msg string, kvs ...any)
  • func (lw *LogWrapper) Error(msg string, kvs ...any)
  • func (lw *LogWrapper) Info(msg string, kvs ...any)
  • func (lw *LogWrapper) With(kvs ...any) cometLog.Logger

Constants

const (
	DataDir          = "data"
	GenesisJSONName  = "genesis.json"
	ConfigTOMLName   = "config.toml"
	AddrBookFileName = "addrbook.json"
)

CometBFT file and folder names. These will be under the chain root directory. e.g. With "abci" a the chain root directory set in cometbft's config, this give the paths "abci/config/genesis.json" and "abci/data".

Functions

func AddrBookPath

func AddrBookPath(chainRootDir string) string

func NodeIDAddressString

func NodeIDAddressString(pubkey ed25519.PubKey, hostPort string) string

NodeIDAddressString makes a full CometBFT node ID address string in the format <nodeID>@hostPort where nodeID is derived from the provided public key.

func ResetState

func ResetState(chainRootDir string) error

ResetState removes address book files plus all blockchain databases.

Types

type CometBftNode

type CometBftNode struct {
	Node *cometNodes.Node
}

func NewCometBftNode

func NewCometBftNode(ctx context.Context, app abciTypes.Application, conf *cometConfig.Config, genDoc *types.GenesisDoc, privateKey cometEd25519.PrivKey, atomicStore privval.AtomicReadWriter, log *log.Logger) (*CometBftNode, error)

NewCometBftNode creates a new CometBFT node.

func (*CometBftNode) IsCatchup

func (n *CometBftNode) IsCatchup() bool

IsCatchup returns true if the node is operating in ccatchup / blocksync mode. If the node is caught up with the network, it returns false.

func (*CometBftNode) Start

func (n *CometBftNode) Start() error

Start starts the CometBFT node.

func (*CometBftNode) Stop

func (n *CometBftNode) Stop() error

Stop stops the CometBFT node.

type LogWrapper

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

LogWrapper that implements cometbft's Logger interface.

func NewLogWrapper

func NewLogWrapper(log *log.Logger) *LogWrapper

NewLogWrapper creates a new LogWrapper using the provided Kwil Logger.

func (*LogWrapper) Debug

func (lw *LogWrapper) Debug(msg string, kvs ...any)

func (*LogWrapper) Error

func (lw *LogWrapper) Error(msg string, kvs ...any)

func (*LogWrapper) Info

func (lw *LogWrapper) Info(msg string, kvs ...any)

func (*LogWrapper) With

func (lw *LogWrapper) With(kvs ...any) cometLog.Logger