camino-node

module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2023 License: BSD-3-Clause

README


Node implementation for the Camino Network - a blockchain for the travel industry.

Installation

Camino is an incredibly lightweight protocol, so the minimum computer requirements are quite modest. Note that as network usage increases, hardware requirements may change.

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 20.04/22.04 or macOS >= 12
  • Network: Reliable IPv4 or IPv6 network connection, with an open public port.

If you plan to build Camino-Node from source, you will also need the following software:

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

Official Documentation

Please refer to the official documentation available at Camino Docs for the latest information.

Native Install

Clone the camino-node repository:

git clone [email protected]:chain4travel/camino-node.git
cd camino-node

This will clone and checkout the chain4travel branch.

Building the Camino Node Executable

Build camino-node using the build script:

./scripts/build.sh

The Camino binary, named camino-node, 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 camino-node.

Docker Install

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

Building the docker image of latest camino-node branch can be done by running:

./scripts/build_local_image.sh

To check the built image, run:

docker image ls

The image should be tagged as chain4travel/camino-node: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/camino-node:xxxxxxxx /camino-node/build/camino-node

Running Camino

Connecting to Columbus Testnet

To connect to the Columbus Testnet, run:

./build/camino-node --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

To connect to the Mainnet, run:

./build/camino-node

For detailed instructions on running a validator node on the Camino Network, please refer to the official validator guides.

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

Camino-Node uses multiple tools to generate efficient and boilerplate code.

Supported Platforms

Camino-Node 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 Camino-Node 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:

Camino-Node 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 take security issues seriously and encourage responsible disclosures from our community.

If you have discovered a security vulnerability, please refer to our Security Policy or contact us on Discord.

Directories

Path Synopsis
e2e
e2e implements the e2e tests.
e2e implements the e2e tests.
e2e/banff
Implements tests for the banff network upgrade.
Implements tests for the banff network upgrade.
e2e/ping
Implements ping tests, requires network-runner cluster.
Implements ping tests, requires network-runner cluster.
e2e/static-handlers
Implements static handlers tests for avm and platformvm
Implements static handlers tests for avm and platformvm
e2e/x/transfer
Implements X-chain transfer tests.
Implements X-chain transfer tests.
e2e/x/whitelist-vtx
Implements X-Chain whitelist vtx (stop vertex) tests.
Implements X-Chain whitelist vtx (stop vertex) tests.
tools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL