Node implementation for the Cryft Network - Tokenizing gifts and real-world items with a fast, secure and highly scalable network of nodes.
Cryft 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: 1 TiB
- Nodes running for very long periods of time or nodes with custom configurations may observe higher storage requirements.
- 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 CryftGo from source, you will also need the following software:
Clone the CryftGo repository:
git clone git@github.com:cryft-labs/cryftgo.git
cd cryftgoThis will clone and checkout the master branch.
Build CryftGo by running the build script:
./scripts/build.shThe cryftgo binary is now in the build directory. To run:
./build/cryftgoInstall CryftGo using an apt repository.
If you already have the APT repository added, you do not need to add it again.
To add the repository on Ubuntu, run:
sudo su -
wget -qO - https://downloads.cryft.network/cryftgo.gpg.key | tee /etc/apt/trusted.gpg.d/cryftgo.asc
source /etc/os-release && echo "deb https://downloads.cryft.network/apt $UBUNTU_CODENAME main" > /etc/apt/sources.list.d/cryft.list
exitAfter adding the APT repository, install cryftgo by running:
sudo apt update
sudo apt install cryftgoDownload the latest build for your operating system and architecture.
The Cryft binary to be executed is named cryftgo.
Make sure Docker is installed on the machine - so commands like docker run etc. are available.
Building the Docker image of latest cryftgo branch can be done by running:
./scripts/build_image.shTo check the built image, run:
docker image lsThe image should be tagged as cryftplatform/cryftgo:xxxxxxxx, where xxxxxxxx is the shortened commit of the Cryft source it was built from. To run the Cryft node, run:
docker run -ti -p 9650:9650 -p 9651:9651 cryftplatform/cryftgo:xxxxxxxx /cryftgo/build/cryftgoTo connect to the Cryft Mainnet, run:
./build/cryftgoYou should see some pretty ASCII art and log messages.
You can use Ctrl+C to kill the node.
To connect to the Mustang Testnet, run:
./build/cryftgo --network-id=mustangThe cryft-cli is the easiest way to start a local network.
cryft network start
cryft network statusA node needs to catch up to the latest network state before it can participate in consensus and serve API calls. This process (called bootstrapping) currently takes several days for a new node connected to Mainnet.
A node will not report healthy until it is done bootstrapping.
Improvements that reduce the amount of time it takes to bootstrap are under development.
The bottleneck during bootstrapping is typically database IO. Using a more powerful CPU or increasing the database IOPS on the computer running a node will decrease the amount of time bootstrapping takes.
CryftGo uses multiple tools to generate efficient and boilerplate code.
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.31.0), protoc-gen-go (v1.33.0) and protoc-gen-go-grpc (v1.3.0) installed.
To install the buf dependencies:
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.33.0
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0If 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.shFor more information, refer to the GRPC Golang Quick Start Guide.
To regenerate the gomock code, run scripts/mock.gen.sh from the root of the repo.
This should only be necessary when modifying exported interfaces or after modifying scripts/mock.mockgen.txt.
CryftGo is first and foremost a client for the Cryft network. The versioning of CryftGo follows that of the Cryft network.
v0.x.xindicates a development network version.v1.x.xindicates a production network version.vx.[Upgrade].xindicates the number of network upgrades that have occurred.vx.x.[Patch]indicates the number of client upgrades that have occurred since the last network upgrade.
Because CryftGo's version denotes the network version, it is expected that interfaces exported by CryftGo's packages may change in Patch version updates.
APIs exposed when running CryftGo will maintain backwards compatibility, unless the functionality is explicitly deprecated and announced when removed.
CryftGo 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 CryftGo 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:
| CryftGo continuous integration | Tier 1 | Tier 2 | Tier 3 |
|---|---|---|---|
| Build passes | ✓ | ✓ | ✓ |
| Unit and integration tests pass | ✓ | ✓ | |
| End-to-end and stress tests pass | ✓ |
We and our community welcome responsible disclosures.
Please refer to our Security Policy and Security Advisories.