Connection

This page provides guides to install shredstream software

Connection Architect

Validator (SHIROI client)

     │   Shred UDP packets

 Shredstream Receiver

     │   gRPC / TCP

 Block Builder Module (BBM)
  • The validator generates and broadcasts shred packets to the network.

  • Shredstream Receiver accepts incoming streams, performs preliminary processing, and forwards them to BBM.

  • BBM uses the received data to build and prioritize blocks in line with the Proposer–Builder Separation (PBS) model.

Environment Requirements

Before connecting, make sure that:

  • the client is built with Shredstream support (--features shredstream);

  • the UDP/TCP port specified for receiving the shred stream is open (default: 8899);

  • outbound traffic to the BBM endpoint (RPC/gRPC) is allowed.

Example System Requirements:

Component
Minimum
Recommended

CPU

8 cores

16 cores

RAM

32 GB

64 GB

Network

1 Gbit

10 Gbit, low latency


Client Configuration

Sample configuration (config.toml)

[shredstream]
enabled = true
bind_address = "0.0.0.0:8899"
max_buffer_size = 4096
priority_enabled = true
grpc_endpoint = "https://bbm.shiroi.network:8443"
pbs_mode = true
telemetry = true

CLI Parameters

Parameter
Purpose
Default

--shredstream-enable

Enables Shredstream

false

--shredstream-bind-address

Address for receiving shred packets

0.0.0.0:8899

--shredstream-max-buffer

Shred-stream buffer size

4096

--shredstream-grpc-endpoint

BBM RPC address

localhost:8443

--pbs-mode

Enables Proposer–Builder Separation mode

true


Example Launch

./solana-validator \
  --identity /path/to/validator-keypair.json \
  --entrypoint entry.shiroi.network:8001 \
  --shredstream-enable \
  --shredstream-bind-address 0.0.0.0:8899 \
  --shredstream-grpc-endpoint https://bbm.shiroi.network:8443 \
  --pbs-mode \
  --expected-genesis-hash <GENESIS_HASH>

After startup, the client will establish a connection to BBM and begin streaming shreds in real time. The logs will display:

[Shredstream] Connected to BBM endpoint https://bbm.shiroi.network:8443
[Shredstream] Stream active, packets: 25000/s, latency: 1.8ms

Monitoring & Debugging

The following Prometheus metrics are available for connection health:

Metric
Description

shredstream_packets_total

Total number of processed shred packets

shredstream_latency_avg

Average latency (ms)

shredstream_dropped_packets

Number of dropped packets

shredstream_bbm_sync_status

Synchronization status with BBM

shredstream_cpu_usage

CPU usage by the Shredstream module

Viewing status:

curl http://localhost:9090/metrics | grep shredstream

Common Issues

Symptom
Possible Cause
Resolution

Connection is not established

Incorrect grpc_endpoint

Verify BBM DNS and SSL

High latency

Insufficient network throughput

Increase MTU; optimize network

Packet loss

OS-level UDP buffer limits

Increase net.core.rmem_max

Synchronization error

Incompatible BBM version

Update BBM to the current SHIROI version


Security

Shredstream supports TLS encryption for connections with BBM and certificate verification. To enable:

[security]
tls_enabled = true
ca_cert_path = "/etc/shiroi/ca.crt"

Last updated