kaiju

README

Kaiju

A lean and mean Bitcoin full node with high concurrency written in golang.

What and Why

Kaiju aims to be the Bitcoin server for Bitcoin service providers, as opposed to Bitcoin Core being the Bitcoin client.

Services need a Bitcoin Server. There are two main reasons why Bitcoin Core (bitcoind) is not the perfect tool for Exchanges and Payment providers.

• It's not designed to connect a big number of nodes, but Services tend to like more connected nodes for better user experience.
• It's an all-in-one bundle containing a wallet and a miner, which are offen not used but introduce undesired complexcity.

Kaiju is designed to handle thouthands of connnections. And it does only one thing and try to be good at it: Being a lean and mean Bitcoin node, to communicate with the network, to verify Txs and Blocks.

KDB

A compact TXDatabase will be used in Kaiju, so that you don't need to store the full blockchain, but can still verify transactions.

Educational Purpose

When response to conspiracy theories, bitcoiner offen say that Bitcoin is an open source project, and everyone can check out the source code and see it for themselves. But the reality is, the code of Bitcoin Core is hard to read for various of reasons.

Kaiju is planning to be small, clean and simple, hopefully under 5K lines of code. Good documentation for code readers is also part of the plan so that more people could really read and learn.

Current Status

WIP. With about 10K lines of code written, I'd say 90% percent of all the features are done. But the development was suspended as I couldn't allocate time for it, I'll try not keep it this way :)

Documentation

Overview

Constants

Index

• Constants
• Variables
• func ConfigFileDir() string
• type Config
  • func GetConfig() *Config

Constants

const AlertPublicKey = "" /* 130-byte string literal not displayed */

const DialTimeout = 2000

const ListenPort int = 8333

const MaxAddrListSize = 30000

const MaxAlertSingnatureSize = 1024

const MaxAlertSize = 100 * 1024

const MaxDialConcurrency = 100

const MaxInvListSize = 50000

const MaxMessagePayload = 4 * 1024 * 1024

const MaxStrSize = 100 * 1024

const NetWorkMagicMain = 0xD9B4BEF9

const NetWorkMagicTestNet = 0xDAB5BFFA

const NodeServices uint64 = 1

What serivices does this node provides

const ProtocolVersion uint32 = 70002

Bitcoin network protocol version

const UserAgent = "/Kaiju:0.1.0/"

Variables

var NounceInVersionMsg uint64 = uint64(rand.New(rand.NewSource(time.Now().UnixNano())).Int63())

Cannot declared as const but works as a const

Functions

func ConfigFileDir

func ConfigFileDir() string

Types

type Config

type Config struct {
	SeedPeers        []string
	DataDir          string
	TempDataDir      string
	LogFileName      string
	HeadersFileName  string
	KdbFileName      string
	KdbWAFileName    string
	MaxKdbWAValueLen int
	KDBCapacity      uint32
}

func GetConfig

func GetConfig() *Config