tpuproxy/README.md

56 lines
1.8 KiB
Markdown
Raw Normal View History

2022-09-15 11:25:20 -07:00
# radiance ☀️
2022-01-25 05:13:42 -08:00
Highly experimental Solana Go playground monorepo.
⚠️ **No guarantees, no support, quite possibly no documentation either.
Ignore this repo unless you're ready to read and understand the code.** ⚠️
## Available tooling
2022-09-25 15:54:45 -07:00
- [radiance](cmd/radiance)
- `blockstore`: Solana validator RocksDB tool
- `dumpshreds`: Dump raw shreds from RocksDB
- `verifydata`: Check data integrity (parse every tx)
- `yaml`: Dump shreds, entries, txs as YAML
- `car`: IPLD Content Addressable Archives
- `create`: Create replayable CAR archives from validator RocksDB
- [solrays](cmd/solrays), an RPC proxy that exports call latency of a Solana RPC node.
## Building
Radiance commands can be built with standard Go tooling (Go >= 1.19 is required),
for example:
go run go.firedancer.io/radiance/cmd/radiance
By default, commands that require extra dependencies (e.g. RocksDB) are disabled.
### With RocksDB
Radiance tools that require direct access to the blockstore (such as `blockstore` and `car`)
require a working C toolchain and extra compiler arguments to link against rocksdb.
You'll need a working C compiler toolchain as well as prerequisites listed
by [grocksdb](https://github.com/linxGnu/grocksdb#prerequisite) and
[RocksDB itself](https://github.com/linxGnu/grocksdb#prerequisite).
For RHEL/Centos/Fedora:
dnf -y install "@Development Tools" gflags-devel snappy snappy-devel zlib zlib-devel bzip2 bzip2-devel lz4-devel libzstd-devel
First, check out the rocksdb submodule:
git submodule update --init
Then, build the rocksdb C library:
cd third_party/rocksdb
make -j $(nproc) static_lib
Finally, build the `radiance` command:
export CGO_CFLAGS="-I$(pwd)/third_party/rocksdb/include"
export CGO_LDFLAGS="-L$(pwd)/third_party/rocksdb"
go run -tags rocksdb go.firedancer.io/radiance/cmd/radiance