Sig is a Solana validator client implemented in Zig. Read the introductory blog post for more about the goals of this project.

⚠️ NOTE: This is a WIP, please open any issues for any bugs/improvements.

• Zig 0.11.0 - Choose one:
  • Binary Releases (extract and add to PATH)
  • Install with a package manager
  • Manage multiple versions with zigup or zvm

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "zig build",
            "type": "shell",
            "command": "zig",
            "args": [
                "build",
                "--summary",
                "all"
            ],
            "options": {
                "cwd": "${workspaceRoot}"
            },
            "presentation": {
                "echo": true,
                "reveal": "always",
                "focus": false,
                "panel": "shared",
                "showReuseMessage": true,
                "clear": false
            },
            "problemMatcher": [],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "lldb",
            "request": "launch",
            "name": "Debug Gossip Mainnet",
            "program": "${workspaceFolder}/zig-out/bin/sig",
            "args": ["gossip", "--entrypoint", "34.83.231.102:8001", "--entrypoint", "145.40.67.83:8001", "--entrypoint", "147.75.38.117:8001", "--entrypoint", "145.40.93.177:8001", "--entrypoint", "86.109.15.59:8001"],
            "cwd": "${workspaceFolder}",
            "preLaunchTask": "zig build"
        },
    ]
}

zig build

Run Sig with zig or execute the binary you already built:

zig build run -- --help

./zig-out/bin/sig --help

These commands will be abbreviated as sig in the rest of this document.

Sig stores its private key in ~/.sig/identity.key. On its first run, Sig will automatically generate a key if no key exists. To see the public key, use the identity subcommand.

sig identity

To run Sig as a Solana gossip client, use the gossip subcommand. Specify entrypoints to connect to a cluster. Optionally use -p to specify a custom listening port (default is 8001). For more info about gossip, see the readme.

sig gossip -p <PORT> --entrypoint <IP>:<PORT>

The following IP addresses were resolved from domains found at https://docs.solana.com/clusters.

sig gossip --entrypoint 34.83.231.102:8001 \
    --entrypoint 145.40.67.83:8001 \
    --entrypoint 147.75.38.117:8001 \
    --entrypoint 145.40.93.177:8001 \
    --entrypoint 86.109.15.59:8001

sig gossip --entrypoint 35.197.53.105:8001 \
    --entrypoint 147.75.55.147:8001 \
    --entrypoint 136.144.49.15:8001 \
    --entrypoint 145.40.71.85:8001 \
    --entrypoint 147.75.105.51:8001

sig gossip --entrypoint 35.203.170.30:8001 \
    --entrypoint 139.178.68.207:8001

See Setup to get your environment set up. See CONTRIBUTING.md for the code style guide.

Run all tests.

zig build test

Include --summary all with any test command to see a summary of the test results.

Include a filter to limit which tests are run. Sig tests include their module name. For example, you can run all tests in gossip.crds_table like this:

zig build test --summary all -- gossip.crds_table

Run all benchmarks.

zig build benchmark

Run a benchmark group: socket_utils, gossip, or sync.

zig build benchmark -- gossip

Sig can be included as a dependency in your Zig project using build.zig.zon file (available for Zig >= 0.11). See the API documentation to learn more about how to use Sig as a library.

Zig's own definition: Zig is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.

1. Optimized performance: Zig provides control over how your program runs at a low level, similar to languages like C. It allows fine-grained control over aspects such as memory management and system calls, which can lead to improved performance.

2. Safety focus: Zig has features built in to prevent common bugs and safety issues common in C. For example, it includes built-in testing and bounds checking, which can help avoid problems such as buffer overflows and undefined behavior.

3. Readability and maintainability: Zig syntax is designed to be straightforward and clear. This can make the code easier to understand, more maintainable, and less prone to bugs.

4. No hidden control flow: Zig doesn't allow hidden control-flow like exceptions in some other languages. This can make it easier to reason about what your program is doing.

5. Integration with C: Zig has excellent interoperation with C. You can directly include C libraries and headers in a Zig program, which can save time when using existing C libraries.

6. Custom allocators: Zig allows you to define custom memory allocation strategies for different parts of your program. This provides the flexibility to optimize memory usage for specific use-cases or workloads.

• Zig is still an evolving language.
• Many of the low-level APIs have been stabilized but std.http.Client and std.json are still WIP targetting stable implementations by >=0.11.
• Currently, std.http.Client leaks and is failing some tests, fix is in works.
  
  

• Gossip - A gossip spy node, run by: sig gossip or zig build run -- gossip

• Core - Core data structures shared across modules.

• RPC Client (docs) - A fully featured HTTP RPC client with ability to query all on-chain data along with sending transactions.
  
  

Zig

• Official Documentation
• Ziglearn Book
• Ziglings Exercises

Solana

• Validator Anatomy
• RPC API
• Code

Sig

• Introduction
• Gossip Deep Dive