proto/

directory
v1.23.4 Latest Latest
Warning

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

Go to latest
Published: Feb 1, 2026 License: BSD-3-Clause

README

Lux gRPC

Now Serving: Protocol Version 42

Protobuf files are hosted at https://buf.build/luxfi/lux and can be used as dependencies in other projects.

Protobuf linting and generation for this project is managed by buf.

Please find installation instructions on https://docs.buf.build/installation/.

Any changes made to proto definition can be updated by running protobuf_codegen.sh located in the scripts/ directory of Lux Node.

buf Quickstart https://buf.build/docs/cli/quickstart

Protocol Version Compatibility

The protobuf definitions and generated code are versioned based on the RPCChainVMProtocol defined for the RPCChainVM. Many versions of a Lux client can use the same RPCChainVMProtocol. But each Lux client and chain VM must use the same protocol version to be compatible.

Publishing to Buf Schema Registry

  • Checkout appropriate tag in Lux Node git checkout v1.10.1
  • Change to proto/ directory cd proto.
  • Publish new tag to buf registry. buf push -t v26

Note: Publishing requires auth to the luxfi org in buf https://buf.build/luxfi/repositories

Directories

Path Synopsis
Package p2p re-exports P2P types from the appropriate wire format implementation.
Package p2p re-exports P2P types from the appropriate wire format implementation.
pb
p2p
sdk
vm
Package sync re-exports sync types from the appropriate wire format implementation.
Package sync re-exports sync types from the appropriate wire format implementation.
zap
p2p
Package p2p provides P2P message types for network communication.
Package p2p provides P2P message types for network communication.
platformvm
Package platformvm provides Platform VM types for L1 validator operations (ZAP implementation).
Package platformvm provides Platform VM types for L1 validator operations (ZAP implementation).
sync
Package sync provides sync types for merkledb.
Package sync provides sync types for merkledb.
vm
Package vm provides VM types for node-VM communication (ZAP implementation).
Package vm provides VM types for node-VM communication (ZAP implementation).

Jump to

Keyboard shortcuts

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