Python SDK

[roninjin10]

Summary

This is a discussion to gather feedback and feature requests for the Python SDK

Why Python SDK

From chatting with devs, there is a huge demand for a cannonical ethereum library for Python including

• Primitives such as abi encoding ane kekkak
• Contract compilation
• Viem-like JSON-RPC provider
• And of course the ability to execute the EVM like you can with Geth or Revm

Example

"""
Example usage of Guillotine EVM Python bindings.

This file demonstrates various features of the Python bindings.
"""

from guillotine_evm import EVM, Address, U256, Hash, Bytes
from guillotine_evm.compilers import compile_solidity, CompilerError
from guillotine_evm.exceptions import ExecutionError


def basic_evm_usage():
    """Demonstrate basic EVM usage."""
    print("=== Basic EVM Usage ===")
    
    # Create an EVM instance
    with EVM() as evm:
        print("EVM initialized successfully")
        
        # Simple bytecode: PUSH1 42, PUSH1 0, RETURN (returns 42)
        bytecode = bytes.fromhex("602a6000f3")
        
        # Execute bytecode
        result = evm.execute(
            bytecode=bytecode,
            gas_limit=100000
        )
        
        print(f"Execution successful: {result.success}")
        print(f"Gas used: {result.gas_used}")
        print(f"Return data: {result.return_data.hex()}")
        
        if result.error_message:
            print(f"Error: {result.error_message}")


def primitives_usage():
    """Demonstrate primitive type usage."""
    print("\n=== Primitives Usage ===")
    
    # Address examples
    addr1 = Address.from_hex("0x1234567890123456789012345678901234567890")
    addr2 = Address.zero()
    
    print(f"Address 1: {addr1}")
    print(f"Address 2 (zero): {addr2}")
    print(f"Address 1 is zero: {addr1.is_zero()}")
    print(f"Address 2 is zero: {addr2.is_zero()}")
    
    # U256 examples
    num1 = U256.from_int(42)
    num2 = U256.from_hex("0x2a")
    num3 = num1 + num2
    
    print(f"Number 1: {num1}")
    print(f"Number 2: {num2}")
    print(f"Sum: {num3}")
    print(f"Are they equal: {num1 == num2}")
    
    # Hash examples
    hash1 = Hash.from_hex("0x1234567890123456789012345678901234567890123456789012345678901234")
    hash2 = Hash.zero()
    
    print(f"Hash 1: {hash1}")
    print(f"Hash 2 (zero): {hash2}")
    
    # Bytes examples
    bytes1 = Bytes.from_hex("0x123456")
    bytes2 = Bytes.from_bytes(b'\x12\x34\x56')
    
    print(f"Bytes 1: {bytes1}")
    print(f"Bytes 2: {bytes2}")
    print(f"Are they equal: {bytes1 == bytes2}")

def compiler_usage():
    """Demonstrate compiler usage."""
    print("\n=== Compiler Usage ===")
    
    try:
        # Simple Solidity contract
        source = """
        pragma solidity ^0.8.0;
        contract SimpleStorage {
            uint256 value;
            function set(uint256 _value) public { value = _value; }
            function get() public view returns (uint256) { return value; }
        }
        """
        
        # Compile the contract
        result = compile_solidity(source)
        
        print(f"Compilation successful!")
        print(f"Bytecode length: {len(result.bytecode)} bytes")
        print(f"ABI functions: {len(result.abi)}")
        print(f"Compiler: {result.metadata.get('compiler', 'unknown')}")
        
        # Display ABI
        for item in result.abi:
            if item.get("type") == "function":
                print(f"Function: {item.get('name')}")
        
    except CompilerError as e:
        print(f"Compilation failed: {e}")

Timeline

• Currently guillotine is in early alpha with no published binaries and extremely unstable as we ship final features for beta
• We expect to reach relative stability with the zig API and implementation in early August
• We expect to release the golang sdk in Mid August
• Python and TypeScript SDK targets are Late August
• Rust SDK and Swift SDKs will come later in year

Help wanted

The team behind guillotine is primarily TypeScript/Zig/Golang devs. Because of this, we need to collect user feedback for other languages including Python.

Some Python specific open questions

• What type of provider API would python users like to see
• What is best way to package guillotine so users don't have to build for source (wheel?)
• What use cases do users see themselves using a Python ethereum library for

Current work

We have a POC of guillotine in Python that we are using to run some E2E tests. By making the Python SDK our E2E testing framework we guarantee it gets first class support into future.

• python utils for compiling solidity
• some basic ethereum primitive utils
• simple evm library

Note the python SDK was made with heavy AI assistance and as Python noobs we are looking for folks to tell us what we can do better.