Skip to content
Official repository for the golang Celo Blockchain
Go C JavaScript C++ Python Assembly Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci [CircleCI] Build walletkit explicitly & fix test (#411) Aug 19, 2019
.github Update CONTRIBUTING.md (#330) Jul 10, 2019
abe Temporarily disable checking phone hash commitments (#345) Jul 14, 2019
accounts Adds BLS signatures support (#326) Aug 8, 2019
build Assume no validator set diff when getValidators fails in Istanbul Ver… Jun 12, 2019
cmd Adds BLS signatures support (#326) Aug 8, 2019
common Move registry fetch error to global variable (#294) Jun 25, 2019
consensus Istanbul: adds minimum quorum violation logging (#409) Aug 19, 2019
console all: remove the duplicate 'the' in annotations (#17509) Aug 27, 2018
containers/docker containers: drop vagrant support, noone's maintaining it Mar 14, 2018
contract_comm Fix comment date (#386) Aug 19, 2019
contracts contracts/*: golint updates for this or self warning Feb 19, 2019
core Fix arm64 SHL call to fix abi.encodePacked bug (#378) Aug 9, 2019
crypto Fix arm64 SHL call to fix abi.encodePacked bug (#378) Aug 9, 2019
dashboard Merge branch upstream-1.8.23 into master Mar 14, 2019
eth Adds BLS signatures support (#326) Aug 8, 2019
ethclient Move randomness from transactions to block bodies (#278) Jun 18, 2019
ethdb ethdb, rpc: support building on js/wasm (#17709) Oct 15, 2018
ethstats Merge istanbul into (celo) master (#135) Mar 26, 2019
event event/filter: delete unused package (#18063) Nov 8, 2018
internal Rebuild ievmh (#317) Jul 31, 2019
les Rebuild ievmh (#317) Jul 31, 2019
light Rebuild ievmh (#317) Jul 31, 2019
log Merge branch upstream-1.8.23 into master Mar 14, 2019
metrics swarm/metrics: Send the accounting registry to InfluxDB (#18470) Feb 19, 2019
miner Adds BLS signatures support (#326) Aug 8, 2019
mobile Change default datadir to ~/.celo (#340) Jul 13, 2019
node Change default datadir to ~/.celo (#340) Jul 13, 2019
p2p [CircleCI] Build walletkit explicitly & fix test (#411) Aug 19, 2019
params Adds BLS signatures support (#326) Aug 8, 2019
rlp rlp: fix comment typo (#17640) Sep 11, 2018
rpc rpc: Warn the user when the path name is too long for the Unix ipc en… Jan 2, 2019
signer Add GasFeeRecipient field to Transactions, pay gas fees to the GasFee… May 28, 2019
swarm Automatically set GasFeeRecipient, reject light node transactions wit… May 29, 2019
tests Rebuild ievmh (#317) Jul 31, 2019
trie trie: fix error in node decoding (#19111) Feb 19, 2019
vendor Upgrades bls-zexe to latest version to get PoPs (#381) Aug 11, 2019
whisper Merge branch upstream-1.8.23 into master Mar 14, 2019
.bulldozer.yml Add bulldozer automerge support to celo-blockchain repo (#408) Aug 19, 2019
.codecov.yml Add codecov configuration (#195) May 17, 2019
.dockerignore dockerignore, internal/build: forward correct git folder Nov 12, 2017
.gitattributes .gitattributes: enable solidity highlighting on github (#16425) Apr 3, 2018
.gitignore Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
.gitmodules tests: update tests and implement general state tests (#14734) Jul 11, 2017
.mailmap all: update license information (#16089) Feb 14, 2018
.travis.yml travis.yml: add launchpad SSH public key (#19115) Feb 19, 2019
AUTHORS all: switch out defunct set library to different one (#16873) Jul 16, 2018
COPYING all: update license information Jul 7, 2015
COPYING.LESSER all: update license information Jul 7, 2015
Dockerfile Only rebuild rust in Docker with vendor changes (#391) Aug 19, 2019
Dockerfile.alltools Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
Dockerfile.android Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
Dockerfile.androidbuild Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
Dockerfile.arm64 Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
Dockerfile.celo-node Adds BLS signatures support (#326) Aug 8, 2019
Makefile Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
README.md Adds BLS signatures support (#326) Aug 8, 2019
appveyor.yml travis, appveyor: bump to Go 1.11.5 (#18947) Jan 29, 2019
build_arm64_macos.sh Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
cloudbuild-android.yaml Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
cloudbuild.yaml Adds BLS signatures support (#326) Aug 8, 2019
geth-sources.jar Adds BLS signatures support (#326) Aug 8, 2019
interfaces.go Add GasFeeRecipient field to Transactions, pay gas fees to the GasFee… May 28, 2019
npm-android.sh Makes Makefile friendlier to use for Android builds (#385) Aug 11, 2019
package.json Build android automatically (#224) May 30, 2019

README.md

Celo Blockchain

Official golang implementation of the Celo Blockchain, based off of the official golang implementation of the Ethereum protocol.

Building the source

Building Celo requires both a Go (version 1.9 or later), a C compiler and a recent nigthly Rust toolchain. You can install them using your favourite package manager. You may also consult the relevant sections in the Celo Engineering Setup guide.

Once the dependencies are installed, run

make geth

or, to build the full suite of utilities:

make all

Executables

Celo project comes with several wrappers/executables found in the cmd directory.

Command Description
geth The main Celo Blockchain client. It is the entry point into the Celo network (alfajores or private net), capable of running as a full node (default), archive node (retaining all historical state), light node (retrieving data live), or ultralight node. It can be used by other processes as a gateway into the Celo network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. geth --help and the Ethereum CLI Wiki page for command line options.
abigen Source code generator to convert Celo contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain Ethereum contract ABIs with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see Ethereum's Native DApps wiki page for details.
bootnode Stripped down version of the Celo client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.
evm Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. evm --code 60ff60ff --debug).
gethrpctest Developer utility tool to support the ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the ethereum test suite's readme for details.
rlpdump Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Celo protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. rlpdump --hex CE0183FFFFFFC4C304050583616263).
puppeth a CLI wizard that aids in creating a new Celo network.

Running Celo

Please see the docs page for more instructions on how to run a Celo node connected to the Alfajores testnet.

Configuration

As an alternative to passing the numerous flags to the Celo binary, you can also pass a configuration file via:

$ geth --config /path/to/your_config.toml

To get an idea how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ geth --your-favourite-flags dumpconfig

Note: This works only with celo v1.6.0 and above.

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on the official Celo forum to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Pull requests need to be based on and opened against the master branch.
  • Commit messages should be prefixed with the package(s) they modify.
    • E.g. "eth, rpc: make trace configs optional"

License

The celo-blockchain library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The celo-blockchain binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.

You can’t perform that action at this time.