zabi: A Zig repository from Raiden1411

ZAbi logo

A zig library to interact with EVM blockchains

ZAbi logo

Overview

Zabi aims to add support for interacting with ethereum or any compatible EVM based chain.

Zig Versions

Zabi will support zig v0.13 in separate branches. If you would like to use it you can find it in the zig_version_0.13.0 branch where you can build it against zig 0.13.0. The main branch of zabi will follow the latest commits from zig and the other branch will be stable in terms of zig versions but not features from zabi.

Integration

You can check how to integrate ZABI in your project here

Example Usage

const args_parser = zabi.args;
const std = @import("std");
const zabi = @import("zabi");
const Wallet = zabi.clients.wallet.Wallet(.http);

const CliOptions = struct {
    priv_key: [32]u8,
    url: []const u8,
};

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();

    var iter = try std.process.argsWithAllocator(gpa.allocator());
    defer iter.deinit();

    const parsed = args_parser.parseArgs(CliOptions, gpa.allocator(), &iter);

    const uri = try std.Uri.parse(parsed.url);

    var wallet = try Wallet.init(parsed.priv_key, .{
        .allocator = gpa.allocator(),
        .network_config = .{ .endpoint = .{ .uri = uri } },
    }, false);
    defer wallet.deinit();

    const message = try wallet.signEthereumMessage("Hello World");

    const hexed = try message.toHex(wallet.allocator);
    defer gpa.allocator().free(hexed);

    std.debug.print("Ethereum message: {s}\n", .{hexed});
}

Usage

Explore the docs to find out more on how you can use or integrate Zabi in your project!

Installing Zig

You can install the latest version of zig here or you can also use a version manager like zvm to manage your zig version.

Features

Json RPC with support for http/s, ws/s and ipc connections.
EVM Interpreter that you can use to run contract bytecode.
Wallet instances and contract instances to use for interacting with nodes/json rpc.
Wallet nonce manager that uses a json rpc as a source of truth.
BlockExplorer support. Only the free methods from those api endpoints are supported.
Custom Secp256k1 ECDSA signer using only Zig and implementation of RFC6979 nonce generator.
Custom JSON Parser that can be used to deserialize and serialized RPC data at runtime.
Custom solidity tokenizer and parser generator.
Ability to translate solidity source code to zig.
ABI to zig types.
Support for EIP712.
Support for EIP3074 authorization message.
Parsing of human readable ABIs into zig types with custom Parser and Lexer.
HD Wallet and Mnemonic passphrases.
RLP Encoding/Decoding.
SSZ Encoding/Decoding.
ABI Encoding/Decoding with support for Log topics encoding and decoding.
Parsing of encoded transactions and serialization of transaction objects.
Support for all transaction types and the new EIP4844 KZG commitments.
Support for OPStack and ENS.
Custom meta programming functions to translate ABI's into zig types.
Support for interacting with test chains such as Anvil or Hardhat.
Custom RPC server used to fuzz data. Support http, ws and ipc.
Custom cli args parser that translates commands to zig types and can be used to pass data to methods.
Custom data generator usefull for fuzzing.

And a lot more yet to come...

Goal

The goal of zabi is to be one of the best library to use by the ethereum ecosystem and to expose to more people to the zig programming language.

Contributing

Contributions to Zabi are greatly appreciated! If you're interested in contributing to ZAbi, feel free to create a pull request with a feature or a bug fix.
You can also read the contributing guide before submitting a pull request

Raiden1411/zabi