Skip to content

Commit

Permalink
reverted to ultd/bincode-zig, updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ultd committed Jul 18, 2023
1 parent 374fdbe commit fcbc9f6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion build.zig.zon
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.hash = "122090e7cb4459c2224399a45c56f47462733b919aa547c96b8c14ee705bfa22976e",
},
.@"bincode-zig" = .{
.url = "https://github.com/0xNineteen/bincode-zig/archive/6b8cbfe412ce87a8f21062c3c53e67e56c5f9b94.tar.gz",
.url = "https://github.com/ultd/bincode-zig/archive/adb1b6da05052b3f3a8cef2a5cbc2cc359acb91c.tar.gz",
.hash = "122024b878fc84c240e5e3551cf86dd9c8ac5ff547deddf34e978f8c45b591cc7543",
},
.@"zig-cli" = .{
Expand Down
14 changes: 10 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br/>

<p align="center">
<h1>&nbsp;🤖⚡ &nbsp;<code>Sig</code> - a Solana Zig client</h1>
<h1>&nbsp;🤖⚡ &nbsp;<code>Sig</code> - a Solana Zig validator client</h1>
<br/>
<br/>
<a href="https://github.com/syndica/sig/releases/latest"><img alt="Version" src="https://img.shields.io/github/v/release/syndica/sig?include_prereleases&label=version"></a>
Expand All @@ -13,10 +13,12 @@

## Overview

_Sig_ is a Solana RPC client implementation written in Zig.
_Sig_ is a Solana validator client implementation written in Zig.
<br/>
<br/>

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

## Why Zig?

Zig's own definition: `Zig is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.`
Expand All @@ -37,15 +39,19 @@ Zig's own definition: `Zig is a general-purpose programming language and toolcha

- Zig is still a 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`.
- This library was compiled and tested using `0.11.0-dev.3218+b873ce1e0` (master).
- This library was compiled and tested using `0.11.0-dev.3997+546212ff7` (master).
- Zig is targeting end of Q2 2023 for [`0.11` milestone](https://github.com/ziglang/zig/milestone/17).
- Currently, `std.http.Client` [leaks](https://github.com/ziglang/zig/blob/447a30299073ce88b7b26d18d060a345beac5276/lib/std/http/Client.zig#L913) and is failing some tests, fix is in works.
<br/>
<br/>

## Modules:

- **RPC Client** - A fully featured HTTP RPC client with ability to query all on-chain data along with sending transactions.
- **Gossip** - A gossip spy node, run by: `sig gossip` or `zig build run -- gossip`

- **Core** - Core data structures shared across modules

- **RPC Client** - A fully featured HTTP RPC client with ability to query all on-chain data along with sending transactions

## Installation

Expand Down

0 comments on commit fcbc9f6

Please sign in to comment.