coreutils provides the shared building blocks used to run a Sia node. Where
go.sia.tech/core defines the
consensus rules and wire types, coreutils implements the moving parts around
them: applying blocks and maintaining chain state, syncing with peers, managing
a wallet, and speaking the renter-host protocol. It is consumed by the reference
node implementations walletd,
renterd, and
hostd.
go get go.sia.tech/coreutils@latestRequires Go 1.26 or later.
Manages blockchain state. The Manager validates and applies blocks, tracks the
best chain across reorgs, maintains the transaction pool, and notifies
subscribers of changes. NewDBStore backs it with a pluggable key-value store
(DB); chain.Mainnet() and chain.TestnetZen() return the network parameters
and genesis block for the public networks.
network, genesis := chain.Mainnet()
db, _ := coreutils.OpenBoltChainDB("consensus.db")
store, tipState, _ := chain.NewDBStore(db, network, genesis, nil)
cm := chain.NewManager(store, tipState)A P2P node that connects to peers, relays blocks and transactions, and keeps the
chain.Manager in sync with the network. It speaks the gateway protocol over a
net.Listener and persists peer data through a PeerStore.
SingleAddressWallet, a wallet that derives a single address from a seed. It
tracks the address's UTXOs and events by following the chain, and selects and
signs inputs when funding transactions. wallet.NewSeedPhrase and the seed
helpers cover BIP-39 phrase generation and key derivation.
The renter-host protocol, version 4. It provides both the renter-side RPC*
client calls (form, renew, and refresh contracts; read, write, and manage
sectors; fund accounts) and the host-side Server. Two interchangeable
transports are included: siamux (the native mux over TCP) and quic.
Top-level helpers: MineBlock / FindBlockNonce for CPU mining (useful for
tests and dev networks) and BoltChainDB, a bbolt-backed
implementation of the chain.DB interface.
A small utility for coordinated shutdown — track in-flight goroutines and derive contexts that cancel when the group is stopped.
Helpers for writing tests against these packages: throwaway networks with early hardfork activation, in-memory stores, block mining, and mock hosts.
Issues and pull requests are welcome. Please run go test ./... before
submitting changes.
coreutils is released under the MIT License.