Code Layout Overview

Overview of codes.

All codes directories are listed here. (in alphabetical order)

directory	description	details
abi	Move (language for smart contracts) ABI
account	implementation of accounts
benchmarks	using cargo bench to measure code performance	README
block-relayer	blocks transaction service
chain	core of Starcoin chain
cmd	command-line tools source codes	binary file description
commons	independent tool crate	README
config	default configs of Starcoin chain and cmd, and methods to build config structs
consensus	implementation of blockchain consensus
contrib-contracts	contribution move libraries, which are not suitable to be in Starcoin stdlib	README
dataformat-generator	generates onchain_events.yml & starcoin_types.yml
docker	docker config for Starcoin
etc	onchain_events.yml & starcoin_types.yml
examples	User Guide of Move Package Manager(mpm)
executor	executor for Starcoin
genesis	lib and tool to generate and load genesis	README
kube	deploy Starcoin on K8S	README
miner	miner service
network	kit of network
network-p2p	kit of P2P network
network-rpc	kit of RPC network
node	local node
rpc	kit of RPC
scripts	scripts helping for building, testing etc.,
state	maintain the chain state
storage	backend storage of chain
stratum	stratum mining	Stratum Mining Protocol
sync	sync from network
test-helper	test helper functions
testsuite	codes & scripts for setting up test
txpool	handler of txn
types	user-defined types for Starcoin
vm	virtual machine built upon Starcoin