README
¶
luxfi/proto
Canonical schema definitions for the Lux platform. Module path is
github.com/luxfi/proto — the directory now matches (was protocol/).
Layout: ZAP + gRPC side-by-side, 1:1
Same package paths under both zap/ and pb/ (or in files suffixed
_zap.go and _pb.go for thin packages). The Go build picks one
or the other based on the build tag:
| Default (no tag) | -tags grpc |
|---|---|
zap/<pkg>/*_zap.go (//go:build !grpc) |
pb/<pkg>/*_pb.go (//go:build grpc) |
| ZAP-native types + codecs | protobuf-generated types + codecs |
Zero google.golang.org/grpc in dep graph |
Includes google.golang.org/grpc |
ZAP is the canonical wire. The protobuf path exists only for external integrations that mandate OTLP-over-gRPC. Internal Lux services use ZAP exclusively.
Consolidation policy
New schemas land here. This directory is the single source of
truth for any cross-package wire definition. The scattered per-repo
proto/ subdirs (see below) are legacy — they should migrate into
this module when the natural rewrite happens.
Existing scattered locations (do not add to them):
| Path | Status |
|---|---|
~/work/lux/p2p/proto/{zap,pb,p2p}/ |
legacy — to migrate |
~/work/lux/node/proto/zap/ |
legacy — to migrate |
~/work/lux/vm/proto/pb/ |
legacy — to migrate |
~/work/lux/api/schema/proto/ |
legacy — to migrate |
Migration cost is one import-path bump per consumer. Not blocking — fold in as those packages are touched for unrelated reasons.
Hanzo mirror
~/work/hanzo/proto follows the same pattern for the Hanzo platform.
See hanzoai/proto README.
Directories
¶
| Path | Synopsis |
|---|---|
|
node
|
|
|
zap/p2p
Package p2p provides P2P message types for network communication.
|
Package p2p provides P2P message types for network communication. |
|
zap/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). |
|
zap/schema
Package schema reads a .zap schema file.
|
Package schema reads a .zap schema file. |
|
zap/sync
Package sync provides sync types for merkledb.
|
Package sync provides sync types for merkledb. |
|
zap/vm
Package vm provides VM types for node-VM communication (ZAP implementation).
|
Package vm provides VM types for node-VM communication (ZAP implementation). |
|
Package p contains protocol types for the Platform/P chain.
|
Package p contains protocol types for the Platform/P chain. |
|
adopt
Package adopt is the register of networks Lux did not create.
|
Package adopt is the register of networks Lux did not create. |
|
block
Package block is a generated GoMock package.
|
Package block is a generated GoMock package. |
|
block/executor
Package executor is a generated GoMock package.
|
Package executor is a generated GoMock package. |
|
block/executor/executormock
Package executormock is a generated GoMock package.
|
Package executormock is a generated GoMock package. |
|
fx
Package fx is a generated GoMock package.
|
Package fx is a generated GoMock package. |
|
fx/fxmock
Package fxmock is a generated GoMock package.
|
Package fxmock is a generated GoMock package. |
|
security
Package security is the network security model for Lux L1/L2 networks (LP-018 §"Network security modes").
|
Package security is the network security model for Lux L1/L2 networks (LP-018 §"Network security modes"). |
|
signer
Package signer provides the Signer interface for BLS signatures.
|
Package signer provides the Signer interface for BLS signatures. |
|
signer/signermock
Package signermock is a generated GoMock package.
|
Package signermock is a generated GoMock package. |
|
stakingparams
Package stakingparams is the node-policy the validator set governs, plus the pure rule that decides whether a proposed change is admissible.
|
Package stakingparams is the node-policy the validator set governs, plus the pure rule that decides whether a proposed change is admissible. |
|
state
Package state is a generated GoMock package.
|
Package state is a generated GoMock package. |
|
testcontext
Package testcontext provides a test context for platformvm tests
|
Package testcontext provides a test context for platformvm tests |
|
txs
Package txs is a generated GoMock package.
|
Package txs is a generated GoMock package. |
|
txs/builder
Package builder is a generated GoMock package.
|
Package builder is a generated GoMock package. |
|
txs/fee
TODO: Before Quasar Edition, address all TODOs in this package and ensure LP-103 compliance.
|
TODO: Before Quasar Edition, address all TODOs in this package and ensure LP-103 compliance. |
|
txs/txsmock
Package txsmock is a generated GoMock package.
|
Package txsmock is a generated GoMock package. |
|
utxo
Package utxo is a generated GoMock package.
|
Package utxo is a generated GoMock package. |
|
utxo/utxomock
Package utxomock is a generated GoMock package.
|
Package utxomock is a generated GoMock package. |
|
warp/zwarp
Package zwarp provides ZAP transport for warp messaging.
|
Package zwarp provides ZAP transport for warp messaging. |
|
Package rpcdb is the transport-agnostic Layer B service spec for the remote `database.Database` service.
|
Package rpcdb is the transport-agnostic Layer B service spec for the remote `database.Database` service. |
|
txs
|
|
|
auth
Package auth is the canonical credential-policy gate for P-chain and X-chain mempool admission.
|
Package auth is the canonical credential-policy gate for P-chain and X-chain mempool admission. |
|
mempool
Package mempool is a generated GoMock package.
|
Package mempool is a generated GoMock package. |
|
mempool/mempoolmock
Package mempoolmock is a generated GoMock package.
|
Package mempoolmock is a generated GoMock package. |
|
Package x contains protocol types for the Exchange/X chain.
|
Package x contains protocol types for the Exchange/X chain. |
|
block
Package block is a generated GoMock package.
|
Package block is a generated GoMock package. |
|
block/executor
Package executor is a generated GoMock package.
|
Package executor is a generated GoMock package. |
|
block/executor/executormock
Package executormock is a generated GoMock package.
|
Package executormock is a generated GoMock package. |
|
genesis
Package genesis builds X-Chain (XVM) genesis bytes from a small, caller-supplied descriptor, and owns the codec those bytes are written with.
|
Package genesis builds X-Chain (XVM) genesis bytes from a small, caller-supplied descriptor, and owns the codec those bytes are written with. |
|
metrics/metricsmock
Package metricsmock is a generated GoMock package.
|
Package metricsmock is a generated GoMock package. |
|
state
Package state is a generated GoMock package.
|
Package state is a generated GoMock package. |
|
state/statemock
Package statemock is a generated GoMock package.
|
Package statemock is a generated GoMock package. |
|
state/xvmroot
Package xvmroot computes the xvm execution_root in native Go, byte-identical to the lux-private GPU xvm_root_update kernel (ops/xvm/cuda/xvm_roots.cu) and every backend's CPU oracle.
|
Package xvmroot computes the xvm execution_root in native Go, byte-identical to the lux-private GPU xvm_root_update kernel (ops/xvm/cuda/xvm_roots.cu) and every backend's CPU oracle. |
|
txs
Package txs is the X-chain (xvm) transaction package for the luxfi/node binary.
|
Package txs is the X-chain (xvm) transaction package for the luxfi/node binary. |
|
txs/mempool
Package mempool is a generated GoMock package.
|
Package mempool is a generated GoMock package. |
|
txs/mempool/mempoolmock
Package mempoolmock is a generated GoMock package.
|
Package mempoolmock is a generated GoMock package. |
|
txs/txsmock
Package txsmock is a generated GoMock package.
|
Package txsmock is a generated GoMock package. |
Click to show internal directories.
Click to hide internal directories.