huff-stack-generator

The goal of this project is to automatically generate the stack comments.

From this:

#define macro SET_VALUE2() = takes (2) returns (0) {
    0x04
    0x04
    _XXX_YYY
    0x04
    0x55
    lt
    0x87
    gt
}

#define macro _XXX_YYY() = takes (1) returns (1) {
    0x06
    calldataload
    [VALUE_LOCATION]
    sstore
    0x69
    0x00
}

To this:

#define macro SET_VALUE2() = takes (2) returns (0) {
    0x04      // [$0, $1, 0x04]
    0x04      // [$0, $1, 0x04, 0x04]
    _XXX_YYY  // [$0, $1, 0x04, _XXX_YYY: %0]
    0x04      // [$0, $1, 0x04, _XXX_YYY: %0, 0x04]
    0x55      // [$0, $1, 0x04, _XXX_YYY: %0, 0x04, 0x55]
    lt        // [$0, $1, 0x04, _XXX_YYY: %0, (0x55 < 0x04)]
    0x87      // [$0, $1, 0x04, _XXX_YYY: %0, (0x55 < 0x04), 0x87]
    gt        // [$0, $1, 0x04, _XXX_YYY: %0, (0x87 > (0x55 < 0x04))]
}

#define macro _XXX_YYY() = takes (1) returns (1) {
    0x06              // [$0, 0x06]
    calldataload      // [$0, calldataload(0x06)]
    [VALUE_LOCATION]  // [$0, calldataload(0x06), [VALUE_LOCATION]]
    sstore            // [$0]
    0x69              // [$0, 0x69]
    0x00              // [$0, 0x69, 0x00]
}

How to use

$ cargo run <INPUT_FILE> <OUTPUT_FILE> 

Optional

stack-direction: [--(right/left)]

Example

$ cargo run /home/shafu/huff-stack-generator/macro.huff /home/shafu/huff-stack-generator/out.huff

TODO

• add dup/swap
• use iterator
• support jumps
• huff lexer