caminogo

README

---

Node implementation for the Camino network - a blockchains platform for the touristic market.

Installation

Camino is an quite lightweight protocol which requires only modest minimum computer requirements.

The minimum recommended hardware specification for nodes connected to Mainnet is:

• CPU: Equivalent of 8 AWS vCPU
• RAM: 16 GiB
• Storage: 512 GiB
• OS: Ubuntu 18.04/20.04 or macOS >= 10.15 (Catalina)
• Network: Reliable IPv4 or IPv6 network connection, with an open public port.

If you plan to build CaminoGo from source, you will also need the following software:

• Go version >= 1.17.9
• gcc
• g++

Native Install

Clone the CaminoGo repository:

git clone git@github.com:chain4travel/caminogo.git
cd caminogo

This will clone and checkout to chain4travel branch.

Building the Camino Executable

Build Camino using the build script:

./scripts/build.sh

The Camino binary, named caminogo, is in the build directory.

Binary Install

Download the latest build for your operating system and architecture.

The Camino binary to be executed is named caminogo.

Docker Install

Make sure docker is installed on the machine - so commands like docker run etc. are available.

Building the docker image of latest caminogo branch can be done by running:

./scripts/build_image.sh

To check the built image, run:

docker image ls

The image should be tagged as chain4travel/caminogo:xxxxxxxx, where xxxxxxxx is the shortened commit of the Camino source it was built from. To run the Camino node, run:

docker run -ti -p 9650:9650 -p 9651:9651 chain4travel/caminogo:xxxxxxxx /caminogo/build/caminogo

Running Camino

Connecting to Columbus Testnet

To connect to the Columbus Testnet, run:

./build/caminogo --network-id=columbus

You should see some pretty ASCII art and log messages.

You can use Ctrl+C to kill the node.

Connecting to Camino Mainnet

Not yet launched

Creating a Local Testnet

See this tutorial.

Bootstrapping

A node needs to catch up to the latest network state before it can participate in consensus and serve API calls.

A node will not report healthy until it is done bootstrapping.

Generating Code

Caminogo uses multiple tools to generate efficient and boilerplate code.

Running protobuf codegen

To regenerate the protobuf go code, run scripts/protobuf_codegen.sh from the root of the repo.

This should only be necessary when upgrading protobuf versions or modifying .proto definition files.

To use this script, you must have buf (v1.0.0-rc12), protoc-gen-go (v1.27.1) and protoc-gen-go-grpc (v1.2.0) installed.

To install the buf dependencies:

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.27.1
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0

If you have not already, you may need to add $GOPATH/bin to your $PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

If you extract buf to ~/software/buf/bin, the following should work:

export PATH=$PATH:~/software/buf/bin/:~/go/bin
go get google.golang.org/protobuf/cmd/protoc-gen-go
go get google.golang.org/protobuf/cmd/protoc-gen-go-grpc
scripts/protobuf_codegen.sh

For more information, refer to the GRPC Golang Quick Start Guide.

Running protobuf codegen from docker

docker build -t chain4travel:protobuf_codegen -f api/Dockerfile.buf .
docker run -t -i -v $(pwd):/opt/chain4travel -w/opt/chain4travel chain4travel:protobuf_codegen bash -c "scripts/protobuf_codegen.sh"

Supported Platforms

CaminoGo can run on different platforms, with different support tiers:

• Tier 1: Fully supported by the maintainers, guaranteed to pass all tests including e2e and stress tests.
• Tier 2: Passes all unit and integration tests but not necessarily e2e tests.
• Tier 3: Builds but lightly tested (or not), considered experimental.
• Not supported: May not build and not tested, considered unsafe. To be supported in the future.

The following table lists currently supported platforms and their corresponding CaminoGo support tiers:

Architecture	Operating system	Support tier
amd64	Linux	1
arm64	Linux	2
amd64	Darwin	2
amd64	Windows	3
arm	Linux	Not supported
i386	Linux	Not supported
arm64	Darwin	Not supported

To officially support a new platform, one must satisfy the following requirements:

CaminoGo continuous integration	Tier 1	Tier 2	Tier 3
Build passes	✓	✓	✓
Unit and integration tests pass	✓	✓
End-to-end and stress tests pass	✓

Security Bugs

We and our community welcome responsible disclosures.

If you've discovered a security vulnerability, please report it to us via discord. Valid reports will be eligible for a reward (terms and conditions apply).