Skip to main content

Installing shredjet

The shredjet client runs as a Docker container. To install shredjet, you need to have Docker installed on your machine.

Kindly refer to the Docker installation guide for instructions on how to install Docker.

Firewall​

If you are using a firewall, you need to allow traffic on the following ports:

PortDirectionProtocolDescription
9661OutboundUDP (QUIC)Shredjet server connection.
TVU (8001 by default)InboundUDPSolana validator's TVU port. It is 8001 by default.

Run shredjet container​

Assuming you have the agave-validator running on the machine you want to install shredjet on, you can run the following command to start the shredjet container:

docker run --name shredjet --net host shredjet/client \
    --jet-upstream-addr frankfurt.shredjet.io:9661 \
    --license-key {insert_your_license_here}

Full list of possible arguments:

  -j, --jet-upstream-addr <JET_UPSTREAM_ADDR>
          Address of the upstream shredjet server.
      --pull-only
          Start in pull-only mode, which means opting out of forwarding local shreds to the shredjet cluster.
      --push-only
          Start in push-only mode, which only sending local shreds to the shredjet cluster.
      --lru-cache-size <LRU_CACHE_SIZE>
          LRU dedup cache size. Rule of thumb is avg. shreds per second * 10, to dedup last 10 seconds of streams. [default: 100000]
  -p, --public-ip <PUBLIC_IP>
          Public IP of the interface to receive shreds on. Will attempt to fetch automatically.
  -t, --tvu-port <TVU_PORT>
          agave-validator TVU port [default: 8001]
  -l, --license-key <LICENSE_KEY>
          License Key for the shredjet server. [default: DEMO]
  -l, --local-socket-addrs <LOCAL_SOCKET_ADDRS>
          Address to bind the local QUIC socket to. [default: 0.0.0.0:0]
  -h, --help
          Print help
  -V, --version
          Print version

By default, this starts shredjet in a push&pull mode. Learn more about the modes below.

Push Mode​

If push mode is enabled, shredjet will 'push' or send locally received shreds to the shredjet cluster to improve it's performance. This is the default mode. You can opt out of this mode by using the --pull-only flag.

As a partnered validator, you usually want to start the shredjet client in the --push-only mode.

Pull Mode​

If pull mode is enabled, shredjet will only 'pull' or receive shreds from the shredjet cluster. You can disable this mode by using the --push-only flag.

Arguments​

ArgumentParametersDescriptionDefault
-j, --jet-upstream-addr<SOCKET_ADDRESS>Address of the upstream shredjet server.
-l, --license-key<LICENSE_KEY>License Key to use for authentication with the upstream shredjet server.DEMO
--tvu-port<PORT>Port of the agave-validator (or the jito version) currently running on this machine. Check by running agave-validator contact-info.8001
--pull-onlyStart in pull-only mode, which means opting out of forwarding local shreds to the shredjet cluster.false
--push-onlyStart in push-only mode, which only sending local shreds to the shredjet cluster.false
-p, --public-ip<IPV4_ADDR>Public IP of this machine. Will attempt to fetch automatically if not provided.