README
¶
Kalibrium
Kalibrium full node implementation source code and project assets, written in Golang.
What is Kalibrium
Kalibrium represents a groundbreaking advancement in the realm of cryptocurrency, aiming to redefine transaction speeds and costs. Built upon the PHANTOM protocol—a sophisticated evolution of Nakamoto consensus—Kalibrium introduces near-instantaneous confirmations and unparalleled block times of merely one second.
Kalibrium is evolving with the upcoming integration of smart contracts and support for Web3 technologies. This development is a step towards enhancing the platform's capabilities, allowing for more complex and programmable transactions. It's about laying the groundwork for a more interactive and automated blockchain ecosystem, where users can engage with decentralized applications and services directly on the Kalibrium network. This update is part of our commitment to advancing blockchain functionality, providing our community with the tools they need to explore new possibilities in a decentralized world.
Requirements
Go 1.18 or later.
Installation
Build from Source
-
Install Go according to the installation instructions here: http://golang.org/doc/install
-
Ensure Go was installed properly and is a supported version:
$ go version
- Run the following commands to obtain and install Kalibrium including all dependencies:
$ git clone https://github.com/kalibriumnet/kalibrium
$ cd kalibrium
$ go install . ./cmd/...
- Kalibrium (and utilities) should now be installed in
$(go env GOPATH)/bin. If you did not already add the bin directory to your system path during Go installation, you are encouraged to do so now.
Getting Started
Kalibrium has several configuration options available to tweak how it runs, but all of the basic operations work with zero configuration.
$ Kalibrium
Discord
Join our discord server using the following link: https://discord.gg/qmmRQ9Tz
Issue Tracker
The integrated github issue tracker is used for this project.
Documentation
The documentation is a work-in-progress
License
Kalibrium is licensed under the copyfree ISC License.
Documentation
¶
Overview ¶
Copyright (c) 2018-2019 The kalibriumnet 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.
Kalibrium is a full-node Kalibrium implementation written in Go.
The default options are sane for most users. This means Kalibrium 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:
Kalibrium [OPTIONS]
For an up-to-date help message:
Kalibrium --help
The long form of all option flags (except -C) can be specified in a configuration file that is automatically parsed when Kalibrium starts up. By default, the configuration file is located at ~/.Kalibrium/Kalibrium.conf on POSIX-style operating systems and %LOCALAPPDATA%\Kalibrium\Kalibrium.conf on Windows. The -C (--configfile) flag can be used to override this location.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
appmessage
Package appmessage implements the Kalibrium appmessage protocol.
|
Package appmessage implements the Kalibrium appmessage protocol. |
|
cmd
|
|
|
kalibriumwallet/libkalibriumwallet/bip32/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. |
|
consensus/utils/txscript
Package txscript implements the Kalibrium transaction script language.
|
Package txscript implements the Kalibrium transaction script language. |
|
dagconfig
Package dagconfig defines DAG configuration parameters.
|
Package dagconfig defines DAG configuration parameters. |
|
infrastructure
|
|
|
db/database
Package database provides a database for Kalibrium.
|
Package database provides a database for Kalibrium. |
|
logger
Package logger defines an interface and default implementation for subsystem logging.
|
Package logger defines an interface and default implementation for subsystem logging. |
|
network/addressmanager
Package addressmanager implements concurrency safe Kalibrium address manager.
|
Package addressmanager implements concurrency safe Kalibrium address manager. |
|
stability-tests
|
|
|
testing
|
|
|
Package util provides Kalibrium-specific convenience functions and types.
|
Package util provides Kalibrium-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. |