node

module
v1.10.21 Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2023 License: BSD-3-Clause

README

luxd

Node implementation for the Lux network - a blockchains platform with high throughput, and blazing fast transactions.

Installation

Lux 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 luxd from source, you will also need the following software:

  • Go version >= 1.20.10
  • gcc
  • g++
Building From Source
Clone The Repository

Clone the luxd repository:

git clone git@github.com:luxdefi/node.git
cd node

This will clone and checkout the master branch.

Building luxd

Build luxd by running the build script:

./scripts/build.sh

The node binary is now in the build directory. To run:

./build/luxd
Binary Repository

Install luxd using an apt repository.

Adding the 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.lux.network/node.gpg.key | tee /etc/apt/trusted.gpg.d/node.asc
source /etc/os-release && echo "deb https://downloads.lux.network/apt $UBUNTU_CODENAME main" > /etc/apt/sources.list.d/lux.list
exit
Installing the Latest Version

After adding the APT repository, install node by running:

sudo apt update
sudo apt install node
Binary Install

Download the latest build for your operating system and architecture.

The Lux binary to be executed is named 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 node 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 avaplatform/node:xxxxxxxx, where xxxxxxxx is the shortened commit of the Lux source it was built from. To run the Lux node, run:

docker run -ti -p 9650:9650 -p 9651:9651 avaplatform/node:xxxxxxxx /node/build/luxd

Running Lux

Connecting to Mainnet

To connect to the Lux Mainnet, run:

./build/luxd

You should see some pretty ASCII art and log messages.

You can use Ctrl+C to kill the node.

Connecting to Testnet

To connect to the Testnet Testnet, run:

./build/luxd --network-id=testnet
Creating a Local Testnet

The lux-cli is the easiest way to start a local network.

lux network start
lux network status

Bootstrapping

A 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.

Generating Code

luxd 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.26.1), protoc-gen-go (v1.30.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.30.0
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.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 lux:protobuf_codegen -f api/Dockerfile.buf .
docker run -t -i -v $(pwd):/opt/lux -w/opt/lux lux:protobuf_codegen bash -c "scripts/protobuf_codegen.sh"
Running mock codegen

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.

Versioning

Version Semantics

luxd is first and foremost a client for the Lux network. The versioning of luxd follows that of the Lux network.

  • v0.x.x indicates a development network version.
  • v1.x.x indicates a production network version.
  • vx.[Upgrade].x indicates 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.
Library Compatibility Guarantees

Because luxd's version denotes the network version, it is expected that interfaces exported by luxd's packages may change in Patch version updates.

API Compatibility Guarantees

APIs exposed when running luxd will maintain backwards compatibility, unless the functionality is explicitly deprecated and announced when removed.

Supported Platforms

luxd 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 luxd 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:

luxd 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.

Please refer to our Security Policy and Security Advisories.

Directories

Path Synopsis
api
server
Package server is a generated GoMock package.
Package server is a generated GoMock package.
atomic
Package atomic is a generated GoMock package.
Package atomic is a generated GoMock package.
Package codec is a generated GoMock package.
Package codec is a generated GoMock package.
Package database is a generated GoMock package.
Package database is a generated GoMock package.
ids
Package message is a generated GoMock package.
Package message is a generated GoMock package.
p2p
p2p/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
peer
Package peer is a generated GoMock package.
Package peer is a generated GoMock package.
proto
consensus/snowman
Package snowman is a generated GoMock package.
Package snowman is a generated GoMock package.
engine/common
Package common is a generated GoMock package.
Package common is a generated GoMock package.
engine/lux/state
Package state manages the meta-data required by consensus for an lux dag.
Package state manages the meta-data required by consensus for an lux dag.
engine/lux/vertex
Package vertex is a generated GoMock package.
Package vertex is a generated GoMock package.
engine/snowman/block/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
networking/handler
Package handler is a generated GoMock package.
Package handler is a generated GoMock package.
networking/router
Package router is a generated GoMock package.
Package router is a generated GoMock package.
networking/sender
Package sender is a generated GoMock package.
Package sender is a generated GoMock package.
networking/timeout
Package timeout is a generated GoMock package.
Package timeout is a generated GoMock package.
networking/tracker
Package tracker is a generated GoMock package.
Package tracker is a generated GoMock package.
uptime
Package uptime is a generated GoMock package.
Package uptime is a generated GoMock package.
validators
Package validators is a generated GoMock package.
Package validators is a generated GoMock package.
e2e
e2e/banff
Implements tests for the banff network upgrade.
Implements tests for the banff network upgrade.
e2e/c
AUTOMATICALLY GENERATED.
AUTOMATICALLY GENERATED.
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.
bag
crypto/keychain
Package keychain is a generated GoMock package.
Package keychain is a generated GoMock package.
filesystem
Package filesystem is a generated GoMock package.
Package filesystem is a generated GoMock package.
hashing
Package hashing is a generated GoMock package.
Package hashing is a generated GoMock package.
ips
logging
Package logging is a generated GoMock package.
Package logging is a generated GoMock package.
resource
Package resource is a generated GoMock package.
Package resource is a generated GoMock package.
rpc
set
vms
Package vms is a generated GoMock package.
Package vms is a generated GoMock package.
avm
avm/block
Package block is a generated GoMock package.
Package block is a generated GoMock package.
avm/block/executor
Package executor is a generated GoMock package.
Package executor is a generated GoMock package.
avm/metrics
Package metrics is a generated GoMock package.
Package metrics is a generated GoMock package.
avm/state
Package state is a generated GoMock package.
Package state is a generated GoMock package.
avm/txs
Package txs is a generated GoMock package.
Package txs is a generated GoMock package.
avm/txs/mempool
Package mempool is a generated GoMock package.
Package mempool is a generated GoMock package.
components/lux
Package lux is a generated GoMock package.
Package lux is a generated GoMock package.
components/verify
Package verify is a generated GoMock package.
Package verify is a generated GoMock package.
platformvm/block
Package block is a generated GoMock package.
Package block is a generated GoMock package.
platformvm/block/executor
Package executor is a generated GoMock package.
Package executor is a generated GoMock package.
platformvm/fx
Package fx is a generated GoMock package.
Package fx is a generated GoMock package.
platformvm/state
Package state is a generated GoMock package.
Package state is a generated GoMock package.
platformvm/txs
Package txs is a generated GoMock package.
Package txs is a generated GoMock package.
platformvm/txs/builder
Package builder is a generated GoMock package.
Package builder is a generated GoMock package.
platformvm/txs/mempool
Package mempool is a generated GoMock package.
Package mempool is a generated GoMock package.
platformvm/utxo
Package utxo is a generated GoMock package.
Package utxo is a generated GoMock package.
proposervm
Package proposervm is a generated GoMock package.
Package proposervm is a generated GoMock package.
proposervm/proposer
Package proposer is a generated GoMock package.
Package proposer is a generated GoMock package.
proposervm/state
Package state is a generated GoMock package.
Package state is a generated GoMock package.
registry
Package registry is a generated GoMock package.
Package registry is a generated GoMock package.
wallet
x
merkledb
Package merkledb is a generated GoMock package.
Package merkledb is a generated GoMock package.
sync
Package sync is a generated GoMock package.
Package sync is a generated GoMock package.

Jump to

Keyboard shortcuts

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