CHANGELOG.md

The zkvyper changelog

[Unreleased]

Changed

• The disassembler now only works with files with hexadecimal strings
• The CLI library from deprecated structopt to clap
• Updated to Rust v1.82.0

Fixed

• Cleared return data after calling CREATE/CREATE2

[1.5.7] - 2024-10-31

Added

• More LLVM optimizations

Changed

• Wrapped project metadata into another object for future extensibility
• Supported functions with a return buffer without using vyper function metadata

Fixed

• Incorrect handling of return buffer when vyper function metadata is missing

[1.5.6] - 2024-10-16

Fixed

• The broken --version CLI endpoint

[1.5.5] - 2024-10-14

Added

• The support for IPFS metadata hash type
• The EraVM disassembler
• More LLVM optimizations

Fixed

• The error code when no input files are provided
• Several issues with fragile parsing of --llvm-options

[1.5.4] - 2024-08-27

Added

• More LLVM optimizations

Changed

• Source code files do not affect one another's metadata hash anymore
• Migrated to the LLVM-based assembler and linker
• Updated to Rust v1.80.1

Fixed

• The complex bitwise operations misoptimization

[1.5.3] - 2024-07-31

Added

• The layout, userdoc, devdoc fields to all output modes

Changed

• EraVM assembly must now be requested with zkvyper -f eravm_assembly ...

Removed

• Redundant calls to vyper that were increasing the compilation time

Fixed

• missing 0x prefix in the combined JSON bytecode output
• bound argument that was ignored in loop ranges
• assert_unreachable is now translated to INVALID, burning all gas

[1.5.2] - 2024-07-01

Removed

• Obsolete warnings for extcodesize and ecrecover

Fixed

• Path normalization error with the internal minimal proxy contract

[1.5.1] - 2024-06-27

Added

• The vyper v0.4.0 support
• The --enable-decimals parameter
• The support for compiling multiple files in Yul, LLVM IR, and EraVM assembly modes
• More LLVM optimizations

Changed

• Assembly is now only returned if requested with --output-assembly
• Renamed the zkasm flag to eravm-assembly
• Updated to Rust v1.79.0

Fixed

• Missing output with non-canonical input paths in combined JSON output

[1.5.0] - 2024-06-10

Added

• More LLVM optimizations
• The --llvm-options parameter to pass arbitrary options to LLVM
• The --threads parameter to control the number of threads
• Caching of the underlying compiler's metadata, including --version

Changed

• Updated to EraVM v1.5.0
• Renamed the zkasm flag to eravm
• Updated to Rust v1.78.0

Deprecated

• zkasm alias of eravm flag

Fixed

• The bytes-to-cells LLVM misoptimization
• Excessive RAM usage and compilation time with some projects
• Redundancy in error printing

[1.4.1] - 2024-04-24

Added

• More LLVM optimizations, including jump tables
• The jump table density threshold optimization parameter

Changed

• Updated to LLVM 17

Fixed

• The xor(zext(cmp), -1) optimization bug
• Printing --help if no arguments are provided
• Missing --overwrite flag now triggers an error
• Bytecode is now printed to --output-dir as a hexadecimal string
• The broken pipe error when piping the output to another process

[1.4.0] - 2024-02-19

Added

• The Cancun EVM version support with temporarily unsupported transient storage
• The MCOPY instruction support
• The --evm-version parameter to the CLI
• The create_from_blueprint Vyper built-in support
• An option to disable the system request memoization
• More compiler optimizations

Fixed

• An issue with MCOPY for overlapping memory regions

[1.3.17] - 2024-01-30

Added

• More LLVM optimizations

[1.3.16] - 2024-01-12

Fixed

• Incorrect handling of input paths on Windows

[1.3.15] - 2024-01-05

Added

• An option to fallback to optimizing for size if the bytecode is too large

[1.3.14] - 2023-12-16

Added

• More LLVM optimizations

Fixed

• The incorrect behavior of complex sequences of overflow flags

[1.3.13] - 2023-10-30

Fixed

• The incorrect behavior of complex sequences of modular operations

[1.3.12] - 2023-10-26

Added

• The vyper v0.3.10 support

[1.3.11] - 2023-10-05

Added

• More LLVM optimizations
• Warnings for ecrecover, extcodesize, tx.origin

Changed

• The INVALID instruction now burns all gas
• Moved the standard library functions to LLVM

Fixed

• The crash with exceeded JSON deserialization recursion limit

[1.3.10] - 2023-09-13

Fixed

• An issue with uninitialized immutable values (see GHSA-h8jv-969m-94r4)

[1.3.9] - 2023-07-03

Fixed

• An issue with non-determinism in contract metadata hash

[1.3.8] - 2023-06-29

Changed

• Each contract is now compiled in a separate process

Fixed

• The CLI argument validation to rule out incompatible options

[1.3.7] - 2023-05-29

Added

• The EraVM assembly compilation mode (--zkasm)
• The vyper v0.3.9 support

Fixed

• The evaluation order of EVM instruction arguments in LLL IR

[1.3.6] - 2023-04-18

Added

• The CODESIZE support in runtime code
• An option not to include the metadata hash at the end of bytecode

Changed

• Calldata instructions now return 0 in deploy code

Fixed

• The LLVM crash with memory offsets >= 2^64
• The LLVM crash with ternary operator on fat memory pointers

[1.3.5] - 2023-04-04

Added

• An option to disable the vyper optimizer

Changed

• Increased the stack size for rayon workers to 16 MB
• Improved the CLI interface description (see --help)

[1.3.4] - 2023-03-15

Added

• LLVM options for debugging and verification

[1.3.3] - 2023-03-09

Added

• The contract metadata hash to the end of bytecode
• More optimizations

Changed

• The optimizer settings to support multiple modes
• The optimizer now optimizes for performance instead of size by default

[1.3.2] - 2023-02-14

Added

• The LLVM build commit ID to the --version output
• More LLVM optimizations

Removed

• The long_version field from the combined JSON output

Fixed

• Calls now only copy min(output_size, return_data_size) of the return data

[1.3.1] - 2023-02-06

Changed

• Some ABI data layout parameters

[1.3.0] - 2023-02-02

Added

• The LLVM IR compilation mode (--llvm-ir)

Changed

• System contract calls now use remaining ergs instead of 0
• The LLVM optimization manager to the new one
• The contract ABI to match that of EraVM v1.3
• Moved the event decoding to the system contracts
• Simplified the CLI arguments used for debugging

Removed

• The extcodesize check at the beginning of runtime code

Fixed

• The non-zero initial return data size value
• msg.value >= 2^128 now set the call status code to zero
• BALANCE now returns 0 if address >= 2^160
• KECCAK256 now returns an empty error in case of revert
• SIGNEXTEND now returns the original value if bytes >= 31
• CODESIZE is forbidden in Yul runtime code
• RETURNDATACOPY now reverts on attempt to copy from beyond the return data
• RETURN and REVERT offsets and lengths are now clamped to 2^32 - 1
• Only block hashes of the last 256 blocks are now accessible
• ptr.pack is not optimized out by LLVM anymore

[1.2.2] - 2022-12-16

Added

• More LLVM optimizations

Changed

• Updated LLVM to v15.0.4

Fixed

• The crash with some uncovered LLVM IR nodes
• The missing check for msg.value > 2^128 - 1

[1.2.1] - 2022-12-01

Added

• The option to dump IRs to files
• More contract size optimizations
• The Windows platform support

Changed

• The CODECOPY instruction now produces a compile-time error in the runtime code
• The CALLCODE instruction now emits a compile-time error

Fixed

• The BYTE instruction overflow
• The forwarder constructor unhandled error

[1.2.0] - 2022-10-10

Added

• Many improvements for the memory security and EVM-compatibility
• Optimizations for the heap allocation
• Support for optimizations for the calldata and returndata forwarding
• More LLVM optimizations

Changed

• System contract calls now require a system call flag
• The handling of msg.value is made more robust
• Failed system contract calls now do bubble-up the reverts

[1.1.4] - 2022-09-02

Added

• The compiler versions to the output JSON

Changed

• Unsupported instructions PC, EXTCODECOPY, SELFDESTRUCT now produce compile-time errors

Fixed

• Bloating the array of immutables with zero values

[1.1.3] - 2022-08-16

Added

• Support for the BASEFEE instruction

[1.1.2] - 2022-08-08

Added

• Better compatibility of opcodes GASLIMIT, GASPRICE, CHAINID, DIFFICULTY, COINBASE etc.

[1.1.1] - 2022-07-28

Added

• Support for the SELECT instruction, used by min/max built-ins

[1.1.0] - 2022-07-16

Added

• The initial release