Skip to content

README.md

Latest commit

 

History

History
123 lines (79 loc) · 3.84 KB

README.md

File metadata and controls

123 lines (79 loc) · 3.84 KB

alto-chain

Crates.io Docs.rs

A minimal (and wicked fast) blockchain built with the Commonware Library.

Status

alto-chain is ALPHA software and is not yet recommended for production use. Developers should expect breaking changes and occasional instability.

Setup

To run this example, you must first install Rust and Docker.

Install commonware-deployer

cargo install commonware-deployer

Create Deployer Artifacts

cargo run --bin setup -- generate --peers 50 --bootstrappers 5 --regions us-west-1,us-east-1,eu-west-1,ap-northeast-1,eu-north-1,ap-south-1,sa-east-1,eu-central-1,ap-northeast-2,ap-southeast-2 --monitoring-instance-type c7g.4xlarge --monitoring-storage-size 100 --instance-type c7g.xlarge --storage-size 40 --worker-threads 3 --log-level info --message-backlog 16384 --mailbox-size 16384 --deque-size 10 --dashboard dashboard.json --output assets

We use 1 less worker-threads than the number of vCPUs to leave a core for blocking-threads.

[Optional] Configure Indexer Upload

cargo run --bin setup -- indexer --count <uploaders> --dir assets --url <indexer URL>

The indexer URL is configured separately because it is typically only known after the threshold key is generated (derived in setup generate). The iteration order of this command is deterministic (re-running will update the same configuration files).

[Optional] Configure Explorer

cargo run --bin setup -- explorer --dir assets --backend-url <backend URL>

The backend URL should be a WebSocket endpoint (with a ws:// or wss:// prefix).

Build Validator Binary

Build Cross-Platform Compiler

docker build -t validator-builder .

Compile Binary for ARM64

docker run -it -v ${PWD}/..:/alto validator-builder

Emitted binary validator is placed in assets.

Deploy Validator Binary

cd assets
deployer ec2 create --config config.yaml

Monitor Performance on Grafana

Visit http://<monitoring-ip>:3000/d/chain

This dashboard is only accessible from the IP used to deploy the infrastructure.

[Optional] Update Validator Binary

Re-Compile Binary for ARM64

docker run -it -v ${PWD}/..:/alto validator-builder

Restart Validator Binary on EC2 Instances

deployer ec2 update --config config.yaml

Destroy Infrastructure

deployer ec2 destroy --config config.yaml

Debugging

Missing AWS Credentials

If commonware-deployer can't detect your AWS credentials, you'll see a "Request has expired." error:

2025-03-05T01:36:47.550105Z  INFO deployer::ec2::create: created EC2 client region="eu-west-1"
2025-03-05T01:36:48.268330Z ERROR deployer: failed to create EC2 deployment error=AwsEc2(Unhandled(Unhandled { source: ErrorMetadata { code: Some("RequestExpired"), message: Some("Request has expired."), extras: Some({"aws_request_id": "006f6b92-4965-470d-8eac-7c9644744bdf"}) }, meta: ErrorMetadata { code: Some("RequestExpired"), message: Some("Request has expired."), extras: Some({"aws_request_id": "006f6b92-4965-470d-8eac-7c9644744bdf"}) } }))

EC2 Throttling

EC2 instances may throttle network traffic if a workload exceeds the allocation for a particular instance type. To check if an instance is throttled, SSH into the instance and run:

ethtool -S ens5 | grep "allowance"

If throttled, you'll see a non-zero value for some "allowance" item:

bw_in_allowance_exceeded: 0
bw_out_allowance_exceeded: 14368
pps_allowance_exceeded: 0
conntrack_allowance_exceeded: 0
linklocal_allowance_exceeded: 0