Documentation for the LLL compiler

Note

This documentation is a work in progress, so please exercise appropriate caution. It a personal effort and has no formal connection with the Ethereum Foundation.

Note

Everything in these docs pertains to the Solidity/LLL implementation, specifically the develop branch.

Contents:

• LLL Introduction
  • Background
  • Resources
    • Authoritative Resources
    • Tutorials
    • Original Resources
    • Example Code
• Language Reference
  • LLL Syntax
    • Expressions
    • Compact notation
    • Strings
    • Comments
    • Common conventions
  • EVM Opcodes
  • Parser expressions
    • Arithmetic Operators
      • Multi-ary
      • Binary
      • Unary
    • Macro definition - def
      • Overview
      • Macro names
      • Macro scope
      • Macro arguments
      • Macro example
    • Including files - include
    • Control structures
      • seq
      • raw
      • if
      • when, unless
      • while, until
      • for
      • Logical Operators &&, ||, !
    • Literals - lit
    • Variables
      • Assigning - set
      • Accessing - get
      • Referencing - ref
      • Unassigning - unset
      • Temporary - with
    • Memory allocation - alloc
    • Assembler - asm
    • Code - lll
    • Code size - bytecodesize
  • Built-in Macros
    • Utility
    • Message-calls
    • Contract creation
    • Keccak256/SHA3 functions
    • Returns
    • Storage handling
    • Built-in contracts
    • Ether sub-units
    • Shift instructions
• LLL Compiler
  • Installing the compiler
  • Compiler Options
    • -h,--help
    • -x,--hex
    • -a,--assembly
    • -t,--parse-tree
    • -d,--disassemble
    • -b,--binary
    • -o,--optimise
    • -V,--version
• LLL and the ABI
  • ABI Data format overview
    • Encoding Example
  • Data Types
    • Elementary Types
    • Dynamic Types
  • Passing data
    • Passing data to the Constructor
    • Passing data to a function
    • Returning data from a function
    • Events
      • EVM Log Entry
      • ABI Event
  • Techniques
    • Functions
    • Generating the JSON ABI
    • Using web3.js to call the ABI
    • Worked example
• Common Design Patterns
  • Memory Layout
  • Constructor/Code
  • Functions
  • Input arguments
  • Function Guards
  • Storage
    • Arrays
    • Mappings