tyler-smith / jet

Jet: An LLVM Environment for EVM Contracts

Jet is an experimental project that aims to create a high-performance execution environment for Ethereum Virtual Machine (EVM) contracts using LLVM. By leveraging LLVM's powerful optimization capabilities, Jet seeks to improve the efficiency and speed of EVM contract execution.

Project Goals

• Provide a fast and efficient EVM execution environment
• Utilize LLVM for advanced optimization of EVM bytecode
• Offer a flexible platform for EVM-based blockchain development and research
• Maintain compatibility with existing EVM contracts while exploring performance improvements

Getting Started

Prerequisites

To build and run Jet, you'll need the following:

• Rust (latest stable version)
• LLVM 18.0

Setting Up the Build Environment

1. Install Rust:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Install LLVM 18.0:

   • On macOS (using Homebrew):

     brew install llvm@18

   • On Ubuntu:

     wget https://apt.llvm.org/llvm.sh
     chmod +x llvm.sh
     sudo ./llvm.sh 18

3. Clone the Jet repository:

   git clone https://github.com/tyler-smith/jet.git
   cd jet

Building the Project

1. Set up the LLVM environment variable:

   export LLVM_SYS_180_PREFIX=/usr/local/opt/llvm

2. Build the project:

   make build

Using jetc - The Jet Compiler

jetc is a command-line tool for compiling Ethereum Virtual Machine (EVM) bytecode to LLVM IR using the Jet compiler.

Usage

jetc [OPTIONS] <INPUT>

### Arguments

- `<INPUT>`: Required. This can be either a file path containing EVM bytecode or a hex string of the bytecode itself.

### Options

- `-o, --output <FILE>`: Specifies the output file. If not provided, the result is written to stdout.
- `-a, --address <ADDRESS>`: Sets the address to assign to the contract. Defaults to "0x1234".

Examples

Output LLVM IR

jetc input.evm
jetc 60806040

Build to ASM

jetc 60806040 | llc

Using jetdbg - The Jet Debugger

The jetdbg command allows you to debug and execute EVM contracts using Jet. To run it:

cargo run --bin jetdbg

Project Status

Jet is currently in active development. While significant progress has been made in implementing core EVM functionality, the project is not yet feature-complete. Below is an overview of the current status:

Implemented Features

1. Core Architecture

   • LLVM-based JIT compilation of EVM bytecode
   • Basic execution context management
   • Stack and memory operations

2. Opcode Classes

   • Arithmetic Operations
   • Comparison & Bitwise Logic
   • Stack Operations
   • Memory Operations
   • Control Flow
   • KECCAK256

3. Environmental Information

   • Basic block information handling

4. Contract Interaction

   • Simple contract calls CALL, RETURNDATASIZE, RETURNDATACOPY

Upcoming Features

1. Opcode Classes

   • Storage Operations: SLOAD, SSTORE
   • Memory Expansion: MSIZE
   • Stack Operations: TLOAD, TSTORE, MCOPY
   • Calls: DELEGATECALL, STATICCALL, CALLCODE
   • Logs: LOG0, LOG1, LOG2, LOG3, LOG4
   • Contract Management: CREATE, CREATE2, SELFDESTRUCT
   • Block Information: BLOCKHASH, COINBASE, TIMESTAMP, NUMBER, DIFFICULTY, GASLIMIT, CHAINID, SELFBALANCE, BASEFEE, BLOBHASH, BLOBBASEFEE
   • Environmental Information: ADDRESS, BALANCE, ORIGIN, CALLER, CALLVALUE, CALLDATALOAD, CALLDATASIZE, CALLDATACOPY, CODESIZE, CODECOPY, GAS, GASPRICE, EXTCODESIZE, EXTCODECOPY, RETURNDATASIZE, RETURNDATACOPY, EXTCODEHASH

2. Testing and Validation

   • Comprehensive test suite covering all EVM operations
   • Validation against existing EVM implementations

3. Documentation and Usability

   • Detailed documentation of the Jet architecture
   • User guides for integrating Jet into existing systems

4. Performance Optimizations

   • Improved memory management
   • Optimization of frequently used operation sequences

License

This project is licensed under the MIT License - see the LICENSE file for details.