Edit

Getting Starteda

This section will walk you through the requirements needed to run a Coda protocol node on your local machine and connect to the network.

Note

This documentation is for the beta release. The commands and APIs may change before the initial release. Last updated for v0.0.1-beta.2.

Requirementsa

Software: macOS or Linux (currently supports Debian 9 and Ubuntu 18.04 LTS)

Hardware: Sending and receiving coda does not require any special hardware, but participating as a node operator currently requires:

  • at least a 4-core processor
  • at least 8 GB of RAM

GPUs aren't currently required, but may be required for node operators when the protoctol is upgraded.

Network: At least 1 Mbps connection

Installationa

The newest binary releases can be found below. Instructions are provided for macOS and Linux below:

This is a large download, around 1GB, so the install might take some time.

Warning

If you installed coda from a previous release, you'll need to upgrade it so that you won't get banned by the network for using an older client. See instructions below for upgrading both macOS and Linux builds.

macOSa

Install using Homebrew.

brew install codaprotocol/coda/coda

If you already have coda installed from a previous release, run:

brew upgrade coda

You can run coda -help to check if the installation succeeded.

Ubuntu 18.04 / Debian 9a

Add the Coda Debian repo and install:

sudo apt-get remove coda-testnet-postake-medium-curves
echo "deb [trusted=yes] http://packages.o1test.net release main" | sudo tee /etc/apt/sources.list.d/coda.list
sudo apt-get update
sudo apt-get install -t release coda-testnet-postake-medium-curves

If you already have coda installed from a previous release, running the above commands should automatically uninstall and reinstall the newest version. If you're installing Coda from scratch, you may see this error when you run the first command: E: Unable to locate package coda-testnet-postake-medium-curves. You can ignore this - it just means there wasn't a prior release installed.

You can run coda -help to check if the installation succeeded.

Windowsa

Windows is not yet supported. If you have any interest in developing Coda for Windows, please reach out to support@o1labs.org or reach out in the Discord server.

Build from sourcea

If you're running another Linux distro or a different version of macOS, you can try building Coda from source code. Please note that other operating systems haven't been tested thoroughly, and may have issues. Feel free to share any logs and get troubleshooting help in the Discord channel.

Set up port forwarding and any firewallsa

If you are running a firewall, you should allow traffic on TCP port 8302 and UDP port 8303. Additionally, unless the -external-ip YOUR_IP flag is provided, the daemon will use HTTPS (443) and HTTP (80) to try and determine its own IP address.

You may need to configure your router's port forwarding to allow inbound traffic to the following ports through your external IP address.

  • TCP port 8302
  • UDP port 8303

For walk-through instructions see this guide.

Nexta

Now that you've installed Coda and configured your network, let's move on to the fun part - sending a transaction!