Merge branch 'master' of https://github.com/vyperlang/vyper into refa…

…ctor/possible_types

.github/workflows/test.yml

@@ -78,11 +78,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [["3.10", "310"], ["3.11", "311"]]
+        python-version: [["3.11", "311"]]
         # run in modes: --optimize [gas, none, codesize]
-        flag: ["core", "no-opt", "codesize"]
+        opt-mode: ["gas", "none", "codesize"]
+        debug: [true, false]
+        # run across other python versions.# we don't really need to run all
+        # modes across all python versions - one is enough
+        include:
+          - python-version: ["3.10", "310"]
+            opt-mode: gas
+            debug: false
 
-    name: py${{ matrix.python-version[1] }}-${{ matrix.flag }}
+    name: py${{ matrix.python-version[1] }}-opt-${{ matrix.opt-mode }}${{ matrix.debug && '-debug' || '' }}
 
     steps:
     - uses: actions/checkout@v1
@@ -97,7 +104,7 @@ jobs:
       run: pip install tox
 
     - name: Run Tox
-      run: TOXENV=py${{ matrix.python-version[1] }}-${{ matrix.flag }} tox -r -- --reruns 10 --reruns-delay 1 -r aR tests/
+      run: TOXENV=py${{ matrix.python-version[1] }} tox -r -- --optimize ${{ matrix.opt-mode }} ${{ matrix.debug && '--enable-compiler-debug-mode' || '' }} --reruns 10 --reruns-delay 1 -r aR tests/
 
     - name: Upload Coverage
       uses: codecov/codecov-action@v1

docs/compiling-a-contract.rst

@@ -113,6 +113,23 @@ Remix IDE
 
    While the Vyper version of the Remix IDE compiler is updated on a regular basis, it might be a bit behind the latest version found in the master branch of the repository. Make sure the byte code matches the output from your local compiler.
 
+.. _optimization-mode:
+
+Compiler Optimization Modes
+===========================
+
+The vyper CLI tool accepts an optimization mode ``"none"``, ``"codesize"``, or ``"gas"`` (default). It can be set using the ``--optimize`` flag. For example, invoking ``vyper --optimize codesize MyContract.vy`` will compile the contract, optimizing for code size. As a rough summary of the differences between gas and codesize mode, in gas optimized mode, the compiler will try to generate bytecode which minimizes gas (up to a point), including:
+
+* using a sparse selector table which optimizes for gas over codesize
+* inlining some constants, and
+* trying to unroll some loops, especially for data copies.
+
+In codesize optimized mode, the compiler will try hard to minimize codesize by
+
+* using a dense selector table
+* out-lining code, and
+* using more loops for data copies.
+
 
 .. _evm-version:
 

docs/structure-of-a-contract.rst

@@ -37,13 +37,13 @@ In the above examples, the contract will only compile with Vyper versions ``0.3.
 Optimization Mode
 -----------------
 
-The optimization mode can be one of ``"none"``, ``"codesize"``, or ``"gas"`` (default). For instance, the following contract will be compiled in a way which tries to minimize codesize:
+The optimization mode can be one of ``"none"``, ``"codesize"``, or ``"gas"`` (default). For example, adding the following line to a contract will cause it to try to optimize for codesize:
 
 .. code-block:: python
 
    #pragma optimize codesize
 
-The optimization mode can also be set as a compiler option. If the compiler option conflicts with the source code pragma, an exception will be raised and compilation will not continue.
+The optimization mode can also be set as a compiler option, which is documented in :ref:`optimization-mode`. If the compiler option conflicts with the source code pragma, an exception will be raised and compilation will not continue.
 
 EVM Version
 -----------------

setup.py

@@ -4,7 +4,7 @@
 import re
 import subprocess
 
-from setuptools import find_packages, setup
+from setuptools import setup
 
 extras_require = {
     "test": [
@@ -88,7 +88,7 @@ def _global_version(version):
     license="Apache License 2.0",
     keywords="ethereum evm smart contract language",
     include_package_data=True,
-    packages=find_packages(exclude=("tests", "docs")),
+    packages=["vyper"],
     python_requires=">=3.10,<4",
     py_modules=["vyper"],
     install_requires=[

tests/base_conftest.py

@@ -112,10 +112,10 @@ def w3(tester):
     return w3
 
 
-def _get_contract(w3, source_code, optimize, *args, **kwargs):
+def _get_contract(w3, source_code, optimize, *args, override_opt_level=None, **kwargs):
     settings = Settings()
     settings.evm_version = kwargs.pop("evm_version", None)
-    settings.optimize = optimize
+    settings.optimize = override_opt_level or optimize
     out = compiler.compile_code(
         source_code,
         # test that metadata gets generated

tests/cli/vyper_json/test_parse_args_vyperjson.py

@@ -57,7 +57,7 @@ def test_to_stdout(tmp_path, capfd):
     _parse_args([path.absolute().as_posix()])
     out, _ = capfd.readouterr()
     output_json = json.loads(out)
-    assert _no_errors(output_json)
+    assert _no_errors(output_json), (INPUT_JSON, output_json)
     assert "contracts/foo.vy" in output_json["sources"]
     assert "contracts/bar.vy" in output_json["sources"]
 
@@ -71,7 +71,7 @@ def test_to_file(tmp_path):
     assert output_path.exists()
     with output_path.open() as fp:
         output_json = json.load(fp)
-    assert _no_errors(output_json)
+    assert _no_errors(output_json), (INPUT_JSON, output_json)
     assert "contracts/foo.vy" in output_json["sources"]
     assert "contracts/bar.vy" in output_json["sources"]
 

tests/compiler/__init__.py

@@ -0,0 +1,2 @@
+# prevent module name collision between tests/compiler/test_pre_parser.py
+# and tests/ast/test_pre_parser.py

tests/compiler/test_default_settings.py

@@ -0,0 +1,27 @@
+from vyper.codegen import core
+from vyper.compiler.phases import CompilerData
+from vyper.compiler.settings import OptimizationLevel, _is_debug_mode
+
+
+def test_default_settings():
+    source_code = ""
+    compiler_data = CompilerData(source_code)
+    _ = compiler_data.vyper_module  # force settings to be computed
+
+    assert compiler_data.settings.optimize == OptimizationLevel.GAS
+
+
+def test_default_opt_level():
+    assert OptimizationLevel.default() == OptimizationLevel.GAS
+
+
+def test_codegen_opt_level():
+    assert core._opt_level == OptimizationLevel.GAS
+    assert core._opt_gas() is True
+    assert core._opt_none() is False
+    assert core._opt_codesize() is False
+
+
+def test_debug_mode(pytestconfig):
+    debug_mode = pytestconfig.getoption("enable_compiler_debug_mode")
+    assert _is_debug_mode() == debug_mode

tests/conftest.py

@@ -10,7 +10,7 @@
 
 from vyper import compiler
 from vyper.codegen.ir_node import IRnode
-from vyper.compiler.settings import OptimizationLevel
+from vyper.compiler.settings import OptimizationLevel, _set_debug_mode
 from vyper.ir import compile_ir, optimizer
 
 from .base_conftest import VyperContract, _get_contract, zero_gas_price_strategy
@@ -43,6 +43,7 @@ def pytest_addoption(parser):
         default="gas",
         help="change optimization mode",
     )
+    parser.addoption("--enable-compiler-debug-mode", action="store_true")
 
 
 @pytest.fixture(scope="module")
@@ -51,6 +52,13 @@ def optimize(pytestconfig):
     return OptimizationLevel.from_string(flag)
 
 
+@pytest.fixture(scope="session", autouse=True)
+def debug(pytestconfig):
+    debug = pytestconfig.getoption("enable_compiler_debug_mode")
+    assert isinstance(debug, bool)
+    _set_debug_mode(debug)
+
+
 @pytest.fixture
 def keccak():
     return Web3.keccak

tests/functional/semantics/analysis/test_for_loop.py

@@ -1,7 +1,12 @@
 import pytest
 
 from vyper.ast import parse_to_ast
-from vyper.exceptions import ImmutableViolation, TypeMismatch
+from vyper.exceptions import (
+    ArgumentException,
+    ImmutableViolation,
+    StateAccessViolation,
+    TypeMismatch,
+)
 from vyper.semantics.analysis import validate_semantics
 
 
@@ -59,6 +64,34 @@ def bar():
         validate_semantics(vyper_module, {})
 
 
+def test_bad_keywords(namespace):
+    code = """
+
+@internal
+def bar(n: uint256):
+    x: uint256 = 0
+    for i in range(n, boundddd=10):
+        x += i
+    """
+    vyper_module = parse_to_ast(code)
+    with pytest.raises(ArgumentException):
+        validate_semantics(vyper_module, {})
+
+
+def test_bad_bound(namespace):
+    code = """
+
+@internal
+def bar(n: uint256):
+    x: uint256 = 0
+    for i in range(n, bound=n):
+        x += i
+    """
+    vyper_module = parse_to_ast(code)
+    with pytest.raises(StateAccessViolation):
+        validate_semantics(vyper_module, {})
+
+
 def test_modify_iterator_function_call(namespace):
     code = """
 

tests/parser/exceptions/test_invalid_reference.py

@@ -37,6 +37,24 @@ def foo():
 def foo():
     int128 = 5
     """,
+    """
+a: public(constant(uint256)) = 1
+
+@external
+def foo():
+    b: uint256 = self.a
+    """,
+    """
+a: public(immutable(uint256))
+
+@external
+def __init__():
+    a = 123
+
+@external
+def foo():
+    b: uint256 = self.a
+    """,
 ]
 
 

tests/parser/features/iteration/test_for_range.py

@@ -14,6 +14,23 @@ def repeat(z: int128) -> int128:
     assert c.repeat(9) == 54
 
 
+def test_range_bound(get_contract, assert_tx_failed):
+    code = """
+@external
+def repeat(n: uint256) -> uint256:
+    x: uint256 = 0
+    for i in range(n, bound=6):
+        x += i
+    return x
+    """
+    c = get_contract(code)
+    for n in range(7):
+        assert c.repeat(n) == sum(range(n))
+
+    # check codegen inserts assertion for n greater than bound
+    assert_tx_failed(lambda: c.repeat(7))
+
+
 def test_digit_reverser(get_contract_with_gas_estimation):
     digit_reverser = """
 @external

tests/parser/functions/test_ecrecover.py

@@ -40,3 +40,21 @@ def test_ecrecover_uints2() -> address:
     assert c.test_ecrecover_uints2() == local_account.address
 
     print("Passed ecrecover test")
+
+
+def test_invalid_signature(get_contract):
+    code = """
+dummies: HashMap[address, HashMap[address, uint256]]
+
+@external
+def test_ecrecover(hash: bytes32, v: uint8, r: uint256) -> address:
+    # read from hashmap to put garbage in 0 memory location
+    s: uint256 = self.dummies[msg.sender][msg.sender]
+    return ecrecover(hash, v, r, s)
+    """
+    c = get_contract(code)
+    hash_ = bytes(i for i in range(32))
+    v = 0  # invalid v! ecrecover precompile will not write to output buffer
+    r = 0
+    # note web3.py decoding of 0x000..00 address is None.
+    assert c.test_ecrecover(hash_, v, r) is None

tests/parser/functions/test_slice.py

@@ -2,6 +2,7 @@
 import pytest
 from hypothesis import given, settings
 
+from vyper.compiler.settings import OptimizationLevel
 from vyper.exceptions import ArgumentException, TypeMismatch
 
 _fun_bytes32_bounds = [(0, 32), (3, 29), (27, 5), (0, 5), (5, 3), (30, 2)]
@@ -33,12 +34,15 @@ def slice_tower_test(inp1: Bytes[50]) -> Bytes[50]:
 
 @pytest.mark.parametrize("literal_start", (True, False))
 @pytest.mark.parametrize("literal_length", (True, False))
+@pytest.mark.parametrize("opt_level", list(OptimizationLevel))
 @given(start=_draw_1024, length=_draw_1024, length_bound=_draw_1024_1, bytesdata=_bytes_1024)
-@settings(max_examples=25, deadline=None)
+@settings(max_examples=100, deadline=None)
+@pytest.mark.fuzzing
 def test_slice_immutable(
     get_contract,
     assert_compile_failed,
     assert_tx_failed,
+    opt_level,
     bytesdata,
     start,
     literal_start,
@@ -64,7 +68,7 @@ def do_splice() -> Bytes[{length_bound}]:
     """
 
     def _get_contract():
-        return get_contract(code, bytesdata, start, length)
+        return get_contract(code, bytesdata, start, length, override_opt_level=opt_level)
 
     if (
         (start + length > length_bound and literal_start and literal_length)
@@ -84,12 +88,15 @@ def _get_contract():
 @pytest.mark.parametrize("location", ("storage", "calldata", "memory", "literal", "code"))
 @pytest.mark.parametrize("literal_start", (True, False))
 @pytest.mark.parametrize("literal_length", (True, False))
+@pytest.mark.parametrize("opt_level", list(OptimizationLevel))
 @given(start=_draw_1024, length=_draw_1024, length_bound=_draw_1024_1, bytesdata=_bytes_1024)
-@settings(max_examples=25, deadline=None)
+@settings(max_examples=100, deadline=None)
+@pytest.mark.fuzzing
 def test_slice_bytes(
     get_contract,
     assert_compile_failed,
     assert_tx_failed,
+    opt_level,
     location,
     bytesdata,
     start,
@@ -133,7 +140,7 @@ def do_slice(inp: Bytes[{length_bound}], start: uint256, length: uint256) -> Byt
     """
 
     def _get_contract():
-        return get_contract(code, bytesdata)
+        return get_contract(code, bytesdata, override_opt_level=opt_level)
 
     data_length = len(bytesdata) if location == "literal" else length_bound
     if (

tests/parser/globals/test_getters.py

@@ -35,6 +35,7 @@ def test_getter_code(get_contract_with_gas_estimation_for_constants):
 c: public(constant(uint256)) = 1
 d: public(immutable(uint256))
 e: public(immutable(uint256[2]))
+f: public(constant(uint256[2])) = [3, 7]
 
 @external
 def __init__():
@@ -68,6 +69,7 @@ def __init__():
     assert c.c() == 1
     assert c.d() == 1729
     assert c.e(0) == 2
+    assert [c.f(i) for i in range(2)] == [3, 7]
 
 
 def test_getter_mutability(get_contract):