• Stars
    star
    502
  • Rank 87,851 (Top 2 %)
  • Language
    Go
  • License
    GNU Lesser Genera...
  • Created over 6 years ago
  • Updated 12 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Official repository for the golang Celo Blockchain

Celo Blockchain

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

CircleCI Codecov Discord

Prebuilt Docker images are available for immediate use: us.gcr.io/celo-org/geth. See docs.celo.org/getting-started for a guide to the Celo networks and how to get started.

Documentation for Celo more generally can be found at docs.celo.org

Most functionality of this client is similar to go-ethereum, also known as geth, from which it was forked. If you do not find your question answered by Celo-specific documentation, try searching the geth wiki.

Building the source

Building geth requires both Go (min version 1.15) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make geth

or, to build the full suite of utilities:

make all

Mobile Clients

There are two different commands in the Makefile to build the ios and the android clients.

make ios

and

make android

Note: The android command it applies a git patch (patches/mobileLibsForBuild.patch) required to swap some libs from the go.mod for the client to work, installs those libs, builds the client, and then reverts the patch.

Executables

The Celo blockchain client 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, capable of running as a full node (default), archive node (retaining all historical state), light node (retrieving data live), or lightest node (retrieving minimum number of block headers to verify existing validator set). 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 run).
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).

Running tests

Prior to running tests you will need to run make prepare, this will run two sub rules.

Without first running this make prepare, certain tests will fail.

prepare-system-contracts

This will shallow checkout the celo-monorepo under ../.celo-blockchain-monorepo-checkout relative to this project's root at the commit defined in the file monorepo_commit. Then it will compile the system contracts for use in full network tests. The rule will copy the compiled contracts from celo-monorepo to compiled-system-contracts. If you subsequently edit the system contracts source or monorepo_commit, running the make rule again will re-checkout the monorepo, re-compile the contracts and copy them into place.

monorepo_commit may contain a commit hash or a tag, branch names are forbidden.

In the case that you would like to change the default monorepo checkout location, or that you would like to have multiple checkouts of the monorepo (at different versions) you can set the MONOREPO_PATH variable in the make command, for example:

make prepare-system-contracts MONOREPO_PATH=../alt-monorepo

Note that MONOREPO_PATH should not be set to point at checkouts other than those checked out by the prepare-system-contracts rule, and the checkouts created by the prepare-system-contracts rule should not be manually modified, aside from changing the contract source.

prepare-ethersjs-project

This will install dependencies for the ethersjs-api-check typescript project.

Running Celo

Please see the docs.celo.org/getting-started for instructions on how to run a node connected to the Celo network using the prebuilt Docker image.

Going through all the possible command line flags is out of scope here, please consult geth --help for more complete information. We've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own Celo blockchain client instance.

Full node on the main Celo network

By default, the Celo client will connect to the Mainnet. Running the following command will create a full node that will sync with the Celo network and allow access to all of its functionality.

$ geth console

This command will:

  • Start geth in full sync mode which will download and execute all historical block information.
  • Start up geth's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as geth's own management APIs. This tool is optional and if you leave it out you can always attach to an already running geth instance with geth attach.

A Full node on the Alfajores test network

Smart contract developers will be most interested in the Alfajores testnet. On Alfajores, you can receive testnet Celo through the Alfajores faucet and deploy smart contracts in an environment very similar to Mainnet. More information about the Alfajores testnet can be found on docs.celo.org.

$ geth --alfajores console

Note: Although there are some internal protective measures to prevent transactions from crossing over between the main network and test network, you should make sure to always use separate accounts for testnet-tokens and real-tokens. Unless you manually move accounts, geth will by default correctly separate the two networks and will not make any accounts available between them.

Full node on the Baklava test network

Validators and full node operators will be most interested in the Baklava testnet. On Baklava, you can receive a distribution of testnet Celo Gold to become a validator on the network and test out running a validator for the first time, or try out new infrastructure. More information about the Baklava testnet can be found on docs.celo.org. A full guide to getting started as a validator on Baklava can be found in the Getting Started guides

$ geth --baklava console

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 of how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ geth --your-favourite-flags dumpconfig

Programmatically interfacing geth nodes

As a developer, sooner rather than later you'll want to start interacting with geth and the Celo network via your own programs and not manually through the console. To aid this, geth has built-in support for a JSON-RPC based APIs (standard APIs and geth specific APIs). These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based platforms, and named pipes on Windows).

The IPC interface is enabled by default and exposes all the APIs supported by geth, whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect.

HTTP based JSON-RPC API options:

  • --http Enable the HTTP-RPC server
  • --http.addr HTTP-RPC server listening interface (default: localhost)
  • --http.port HTTP-RPC server listening port (default: 8545)
  • --http.api API's offered over the HTTP-RPC interface (default: eth,net,web3)
  • --http.corsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
  • --ws Enable the WS-RPC server
  • --ws.addr WS-RPC server listening interface (default: localhost)
  • --ws.port WS-RPC server listening port (default: 8546)
  • --ws.api API's offered over the WS-RPC interface (default: eth,net,web3)
  • --ws.origins value Origins from which to accept websockets requests
  • --graphql Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.
  • --graphql.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced)
  • --graphql.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost")
  • --ipcdisable Disable the IPC-RPC server
  • --ipcapi API's offered over the IPC-RPC interface (default: admin,debug,eth,miner,net,personal,shh,txpool,web3)
  • --ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)

You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect via HTTP, WS or IPC to a geth node configured with the above flags and you'll need to speak JSON-RPC on all transports. You can reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert Celo nodes with exposed APIs! Further, all browser tabs can access locally running web servers, so malicious web pages could try to subvert locally available APIs!

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 celo-blockchain, 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"

Submitting an issue

If you come across a bug, please open a GitHub issue with information about your build and what happened.

CI Testing and automerge

We run a circle CI test suite on each PR. The following tests are required to merge a PR.

  • Unit tests: make test or ./build/env.sh go run build/ci.go test
  • Lint: make lint (Fix go format errors with gofmt -s)
  • Build: make
  • End to end sync and transfer tests
  • Check imports: ./scripts/check_imports.sh

celo-blockchain is based on go-ethereum, but the import path has been renamed from github.com/ethereum/go-ethereum to github.com/celo-org/celo-blockchain. Developers are encouraged to run ./scripts/setup_git_hooks.sh to enable checking that import path has been changed to celo-org on git merge and git commit. Imports can automatically be renamed with ./scripts/rename_imports.sh.

Individual package tests can be run with ./build/env.sh go test github.com/celo-org/celo-blockchain/$(PATH_TO_GO_PACKAGE) if you don't have GOPATH set-up.

Once a PR is approved, adding on the automerge label will keep it up to date and do a squash merge once all the required tests have passed.

Benchmarking

Golang has built-in support for running benchmarks with go tool go test -run=ThisIsNotATestName -bench=. ./$PACKAGE_NAME will run all benchmarks in a package.

One note around running benchmarks is that BenchmarkHandlePreprepare is quite takes a while to run, particularly when testing with a larger number of validators. Substituting -bench=REGEX for -bench=. will specify which tests to run. Adding -cpuprofile=cpu.out which can be visualized with go tool pprof -html:8080 cpu.out if graphviz is installed.

See the go testing flags and go docs for more information on benchmarking.

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.

More Repositories

1

celo-monorepo

Official repository for core projects comprising the Celo platform
Solidity
696
star
2

gitcoin

A place to track gitcoin related issues, bounties and quests.
159
star
3

celo-composer

celo-composer is a starter project with all code needed to build, deploy, and upgrade a dapps on Celo.
TypeScript
121
star
4

optics-monorepo

🔮 OPTimistic Interchain Communication
TypeScript
119
star
5

celo-bls-snark-rs

Implements SNARK-friendly BLS signatures
Rust
84
star
6

celo-proposals

Celo Improvement Proposals
61
star
7

celo-threshold-bls-rs

Threshold BLS Signatures and DKG
Rust
59
star
8

react-celo

Connect your react dApp to Celo
TypeScript
59
star
9

docs

TypeScript
58
star
10

governance

Governance Repository for Celo
JavaScript
46
star
11

make-crypto-mobile-hackathon

Build the next generation of Defi accessibility with Celo mobile-first blockchain! Create new solutions on top of the Celo Ledger - DeFi, NFTs, Smart Contracts, Developer tooling and more.
37
star
12

shrubs

JavaScript
27
star
13

build-with-celo-hackathon

21
star
14

rosetta

go server implementation of the Rosetta API spec
Go
20
star
15

savings-circle-demo

TypeScript
17
star
16

SocialConnect

Protocol mapping social identifiers to blockchain addresses
17
star
17

website

OLD Repo for OLD Celo.org Website
TypeScript
15
star
18

celo-bls-go

Go module for https://github.com/celo-org/bls-zexe/
Go
14
star
19

celo-oracle

TypeScript
14
star
20

faucet

Alfajores Faucet
TypeScript
14
star
21

plumo-prover

Prover for the Plumo light client system https://docs.zkproof.org/pages/standards/accepted-workshop3/proposal-plumo_celolightclient.pdf
Rust
14
star
22

no-yolo-signatures

TypeScript
13
star
23

rainbowkit-celo

TypeScript
12
star
24

bls-embedded

Rust
11
star
25

snark-setup-operator

Rust
11
star
26

staked-celo-web-app

TypeScript
10
star
27

bls12377js

TypeScript implementation of BLS12-377-based Proofs of Possession.
TypeScript
10
star
28

developer-tooling

🛠️ SDKs and CLI for interacting with Celo
TypeScript
10
star
29

celo-mondo

Staking and Governance Tools for Celo
TypeScript
9
star
30

staked-celo

TypeScript
8
star
31

DevRel

All things DevRel!
JavaScript
7
star
32

blind-threshold-bls-wasm

WASM Bindings for blind bls threshold signature generation and verification
JavaScript
7
star
33

celo-camp

7
star
34

dappkit-web-starter

TypeScript
7
star
35

stackshift

The Celo Stackshift program
7
star
36

social-connect

Protocol mapping social identifiers to blockchain addresses
TypeScript
7
star
37

hello-celo-contractkit

An introduction to using Celo ContractKit
JavaScript
6
star
38

kliento

Client library for celo (golang)
Go
6
star
39

snark-setup-coordinator

TypeScript
6
star
40

celostats-frontend

TypeScript
6
star
41

reserve-site

Celo Reserve Website
TypeScript
5
star
42

celostats-server

Celo network status dashboard
TypeScript
5
star
43

compliance

TypeScript
5
star
44

celo-ledger-web-app

JavaScript
5
star
45

mento2-model

Jupyter Notebook
5
star
46

awesome-celo

A curated list of awesome Celo resources, libraries, tools and more
5
star
47

eksportisto

Metric Exporter for celo-node
Go
4
star
48

interview_challenge

HTML
4
star
49

komenci

Komenci (Start in esperanto) is the onboarding service that provides Valora with fee-less mobile attestations.
TypeScript
4
star
50

celo-forkmon

Fork Monitor for POA/POS networks, customized for Celo
HTML
4
star
51

plumo-ceremony-attestations

Python
4
star
52

nexus

MiniPay project for external partners
TypeScript
4
star
53

charts

cLabs managed applications for Kubernetes using Helm
Smarty
4
star
54

qa-interview-assignment

Takehome assignment for the cLabs QA Engineer interview process
TypeScript
4
star
55

payments

TypeScript
4
star
56

celo-lms

Celo LMS is a learning management system that allows users to create and manage courses using Markdown.
TypeScript
3
star
57

celo-exchange-bot

TypeScript
3
star
58

OpenSSL-headers

C
3
star
59

dappkit-base

Expo DAppKit Base
JavaScript
3
star
60

celo-token-list

Celo's default token list
TypeScript
3
star
61

typechain-target-web3-v1-celo

TypeScript
3
star
62

geth_exporter

Go
3
star
63

minipay-minidapps

MiniDApps for MiniPay
TypeScript
3
star
64

celo-academy

Source code for Celo Academy.
TypeScript
3
star
65

plumo-verifier

Node.js module for verifying Plumo proofs and reading states based on it
JavaScript
3
star
66

celo-ledger-spender-app-w-docker-build-tools

The Celo spender ledger app used for signing transactions
Dockerfile
3
star
67

SocialConnect-Twitter

SocialConnect Twitter example
TypeScript
3
star
68

SocialConnect-Twitter-Server-Side

SocialConnect Twitter Server Side example
TypeScript
2
star
69

celo-bls-go-android

Go
2
star
70

celo-status

Dashboard to display blockchain node logs publicly
HTML
2
star
71

rosetta-cusd

Module implementation of Coinbase's Rosetta spec for cUSD, to be used in conjunction with the `rosetta` repository.
Go
2
star
72

celo-ledger-token-data

TypeScript
2
star
73

celo-bls-go-ios

Go
2
star
74

celo-bls-go-other

Go
2
star
75

minimal-docker

A minimal docker image with unix utilities
Dockerfile
2
star
76

gcloud-kubectl-docker

A simple docker image containing gcloud and kubectl
Dockerfile
2
star
77

celo-bls-go-linux

Go
2
star
78

blind-threshold-bls-neon

Neon bindings to the Celo threshold BLS library
Rust
2
star
79

celocli

TypeScript
2
star
80

brand

Celo Brand Assets
2
star
81

hardfork-testing

Hardfork Testing Tools & Scripts
Solidity
2
star
82

celo-bls-go-macos

Go
2
star
83

cel2-ethereum-compatibility

🛠️ CEL2 Ethereum-compatibility evaluation
TypeScript
2
star
84

snark

Rust
2
star
85

stokado

Secure off-chain data storage
TypeScript
2
star
86

economics-scripts

TypeScript
2
star
87

celo-poprf-rs

Rust
2
star
88

simple-address-statistics

Basic transaction monitoring for supplied Celo addresses
TypeScript
2
star
89

celo-validator-signer-app

C
2
star
90

ethglobal-brussels

ETHGlobal Brussels
TypeScript
2
star
91

bls12377js-blind

TypeScript
2
star
92

celo-ccip-workshop

This is expample code for Celo Alfajores <> Ethereum Sepolia CCIP.
TypeScript
2
star
93

crypto-pm

1
star
94

terraform-azure

terraform configs for azure
1
star
95

minipay-template

TypeScript
1
star
96

sbi

simple build image: build docker containers, push to registry, interpolate and apply kubernetes manifests
Shell
1
star
97

release-celo-deployments-28

1
star
98

cooperate-demo

Cooperate Demo
TypeScript
1
star
99

health-checker-docker

https://github.com/gruntwork-io/health-checker in a Docker image
Dockerfile
1
star
100

celo-bls-go-windows

Go
1
star