README
¶
iotex-core
Official Golang implementation of the IoTeX protocol.
Welcome to the official Go implementation of IoTeX protocol! IoTeX is building the next generation of the decentralized blockchain protocol for powering real-world information marketplace in a decentralized-yet-scalable way. Refer to IoTeX whitepaper for details.
New to IoTeX?
Please visit https://iotex.io official website or IoTeX onboard pack to learn more about IoTeX network.
Run a delegate?
Please visit IoTeX Delegate Manual for detailed setup process.
Building the source code
Minimum requirements
| Components | Version | Description |
|---|---|---|
| Golang | ≥ 1.18.5 | Go programming language |
| Protoc | ≥ 3.6.0 | Protocol buffers, required only when you rebuild protobuf messages |
Compile
Download the code to your desired local location (doesn't have to be under $GOPATH/src)
git clone git@github.com:iotexproject/iotex-core.git
cd iotex-core
If you put the project code under your $GOPATH\src, you will need to set up an environment variable
export GO111MODULE=on
set GO111MODULE=on (for windows)
Build the project for general purpose (server, ioctl) by
make
Build the project for broader purpose (server, ioctl, injector...) by
make all
If the dependency needs to be updated, run
go get -u
go mod tidy
If you want to learn more advanced usage about go mod, you can find out here.
Run unit tests only by
make test
Build the docker image by
make docker
Run iotex-core
Start (or resume) a standalone server to operate on a blockchain by
make run
Restart the server from a clean state by
make reboot
If "make run" fails due to corrupted or missing state database while block database is in normal condition, e.g., failing to get factory's height from underlying DB, please try to recover state database by
make recover
Then, "make run" again.
Use CLI
Users could interact with iotex blockchain by
ioctl [command]
Refer to CLI document for more details.
Contact
Contribution
We are glad to have contributors out of the core team; contributions, including (but not limited to) style/bug fixes, implementation of features, proposals of schemes/algorithms, and thorough documentation, are welcomed. Please refer to our contribution guideline for more information. Development guide documentation is here.
For any major protocol level changes, we use IIP to track the proposal, decision and etc.
Contributors
Thank you for considering contributing to the IoTeX framework!
License
This project is licensed under the Apache License 2.0.
Directories
¶
| Path | Synopsis |
|---|---|
|
protocol/staking
Package staking is a generated GoMock package.
|
Package staking is a generated GoMock package. |
|
Package db is a generated GoMock package.
|
Package db is a generated GoMock package. |
|
pkg
|
|
|
lifecycle
Package lifecycle provides application models' lifecycle management.
|
Package lifecycle provides application models' lifecycle management. |
|
test
|
|
|
mock/mock_actioniterator
Package mock_actioniterator is a generated GoMock package.
|
Package mock_actioniterator is a generated GoMock package. |
|
mock/mock_actpool
Package mock_actpool is a generated GoMock package.
|
Package mock_actpool is a generated GoMock package. |
|
mock/mock_apicoreservice
Package mock_apicoreservice is a generated GoMock package.
|
Package mock_apicoreservice is a generated GoMock package. |
|
mock/mock_apiresponder
Package mock_apitypes is a generated GoMock package.
|
Package mock_apitypes is a generated GoMock package. |
|
mock/mock_apiserver
Package mock_apiserver is a generated GoMock package.
|
Package mock_apiserver is a generated GoMock package. |
|
mock/mock_batch
Package mock_batch is a generated GoMock package.
|
Package mock_batch is a generated GoMock package. |
|
mock/mock_blockchain
Package mock_blockchain is a generated GoMock package.
|
Package mock_blockchain is a generated GoMock package. |
|
mock/mock_blockcreationsubscriber
Package mock_blockcreationsubscriber is a generated GoMock package.
|
Package mock_blockcreationsubscriber is a generated GoMock package. |
|
mock/mock_blockdao
Package mock_blockdao is a generated GoMock package.
|
Package mock_blockdao is a generated GoMock package. |
|
mock/mock_blockindex
Package mock_blockindex is a generated GoMock package.
|
Package mock_blockindex is a generated GoMock package. |
|
mock/mock_blocksync
Package mock_blocksync is a generated GoMock package.
|
Package mock_blocksync is a generated GoMock package. |
|
mock/mock_chainmanager
Package mock_chainmanager is a generated GoMock package.
|
Package mock_chainmanager is a generated GoMock package. |
|
mock/mock_consensus
Package mock_consensus is a generated GoMock package.
|
Package mock_consensus is a generated GoMock package. |
|
mock/mock_dispatcher
Package mock_dispatcher is a generated GoMock package.
|
Package mock_dispatcher is a generated GoMock package. |
|
mock/mock_factory
Package mock_factory is a generated GoMock package.
|
Package mock_factory is a generated GoMock package. |
|
mock/mock_ioctlclient
Package mock_ioctlclient is a generated GoMock package.
|
Package mock_ioctlclient is a generated GoMock package. |
|
mock/mock_lifecycle
Package mock_lifecycle is a generated GoMock package.
|
Package mock_lifecycle is a generated GoMock package. |
|
mock/mock_nodeinfo
Package mock_nodeinfo is a generated GoMock package.
|
Package mock_nodeinfo is a generated GoMock package. |
|
mock/mock_poll
Package mock_poll is a generated GoMock package.
|
Package mock_poll is a generated GoMock package. |
|
mock/mock_privatekey
Package mock_privatekey is a generated GoMock package.
|
Package mock_privatekey is a generated GoMock package. |
|
mock/mock_sealed_envelope_validator
Package mock_sealed_envelope_validator is a generated GoMock package.
|
Package mock_sealed_envelope_validator is a generated GoMock package. |
|
mock/mock_trie
Package mock_trie is a generated GoMock package.
|
Package mock_trie is a generated GoMock package. |
|
mock/mock_web3server
Package mock_web3server is a generated GoMock package.
|
Package mock_web3server is a generated GoMock package. |
|
tools
|
|
|
addrgen
This is a testing tool to generate iotex addresses To use, run "make build" and " ./bin/addrgen"
|
This is a testing tool to generate iotex addresses To use, run "make build" and " ./bin/addrgen" |
|
readtip
This is a recovery tool that recovers a corrupted or missing state database.
|
This is a recovery tool that recovers a corrupted or missing state database. |
|
staterecoverer
This is a recovery tool that recovers a corrupted or missing state database.
|
This is a recovery tool that recovers a corrupted or missing state database. |