eth.zig -- The Fastest Ethereum Library

How to contribute to eth.zig -- setup, architecture, code style, and PR guidelines.

Contributions are welcome! Here's everything you need to get started.

Prerequisites

Zig >= 0.15.2
Git

Getting Started

git clone https://github.com/StrobeLabs/eth.zig.git
cd eth.zig

# Build
zig build

# Run tests
zig build test

# Check formatting
zig fmt --check src/ tests/

# Format code
zig fmt src/ tests/

Architecture

eth.zig uses a layered architecture where each layer only depends on layers below it. This makes every layer independently testable.

Layer 1:  Primitives     (zero deps, no allocator needed)
          primitives.zig, uint256.zig, hex.zig

Layer 2:  Encoding       (-> primitives)
          rlp.zig, abi_encode.zig, abi_decode.zig, abi_types.zig

Layer 3:  Crypto         (-> primitives)
          keccak.zig, secp256k1.zig, signature.zig

Layer 4:  Types          (-> primitives, encoding, crypto)
          transaction.zig, receipt.zig, block.zig, access_list.zig, blob.zig

Layer 5:  Signer         (-> crypto, types)
          signer.zig, eip155.zig, hd_wallet.zig, mnemonic.zig

Layer 6:  Transport      (-> types)
          http_transport.zig, ws_transport.zig, json_rpc.zig, subscription.zig

Layer 7:  Client         (-> transport, types, encoding)
          provider.zig, wallet.zig

Layer 8:  Contract       (-> client, encoding, signer)
          contract.zig, event.zig, multicall.zig

Layer 9:  Standards      (-> client, contract, crypto)
          eip712.zig, ens/

Layer 10: Chains         (pure data, zero deps)
          chains/