Merge branch 'dev'

Author: montyly

.github/workflows/black.yml

@@ -33,7 +33,7 @@ jobs:
           cp pyproject.toml .github/linters
 
       - name: Black
-        uses: docker://github/super-linter:v3
+        uses: github/super-linter/[email protected]
         if: always()
         env:
           # run linter on everything to catch preexisting problems

.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+---
 name: CI
 
 on:
@@ -8,28 +9,62 @@ on:
   pull_request:
   schedule:
     # run CI every day even if no PRs/merges occur
-    - cron:  '0 12 * * *'
+    - cron: '0 12 * * *'
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        type: ["solc", "truffle", "embark", "etherlime", "brownie", "waffle", "buidler", "hardhat"]
+        os: ["ubuntu-latest", "windows-2022"]
+        type: ["brownie", "buidler", "dapp", "embark", "etherlime", "hardhat", "solc", "truffle", "waffle"]
+        exclude:
+          # Currently broken, tries to pull git:// which is blocked by GH
+          - type: embark
+          # Requires nix
+          - os: windows-2022
+            type: dapp
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
+    - name: Set up shell
+      if: runner.os == 'Windows'
+      run: |
+        echo 'C:\msys64\mingw64\bin' >> "$GITHUB_PATH"
+        echo 'C:\msys64\usr\bin' >> "$GITHUB_PATH"
+    - name: Choose Node version
+      id: node
+      shell: bash
+      run: |
+        if [ ${{ matrix.type }} = etherlime ]; then
+          echo '::set-output name=version::10.17.0'
+        else
+          echo '::set-output name=version::lts/*'
+        fi
+    - name: Set up Node
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ steps.node.outputs.version }}
     - name: Set up Python 3.6
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v3
       with:
         python-version: 3.6
     - name: Install dependencies
       run: |
-        sudo wget -O /usr/bin/solc https://github.com/ethereum/solidity/releases/download/v0.5.7/solc-static-linux
-        sudo chmod +x /usr/bin/solc
+        pip install "solc-select>=v1.0.0b1"
+        solc-select use 0.5.7 --always-install
         pip install .
+    - name: Set up nix
+      if: matrix.type == 'dapp'
+      uses: cachix/install-nix-action@v16
+    - name: Set up cachix
+      if: matrix.type == 'dapp'
+      uses: cachix/cachix-action@v10
+      with:
+        name: dapp
     - name: Run Tests
       env:
         TEST_TYPE: ${{ matrix.type }}
         GITHUB_ETHERSCAN: ${{ secrets.GITHUB_ETHERSCAN }}
+      shell: bash
       run: |
-        bash scripts/travis_test_${TEST_TYPE}.sh
+        bash "scripts/travis_test_${TEST_TYPE}.sh"

.github/workflows/darglint.yml

@@ -1,3 +1,4 @@
+---
 name: Darglint
 
 on:

.github/workflows/etherscan.yml

@@ -1,3 +1,4 @@
+---
 name: CI
 
 on:
@@ -7,28 +8,35 @@ on:
       - dev
   schedule:
     # run CI every day even if no PRs/merges occur
-    - cron:  '0 12 * * *'
+    - cron: '0 12 * * *'
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
+        os: ["ubuntu-latest", "windows-2022"]
         type: ["etherscan"]
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
+    - name: Set up shell
+      if: runner.os == 'Windows'
+      run: |
+        echo 'C:\msys64\mingw64\bin' >> "$GITHUB_PATH"
+        echo 'C:\msys64\usr\bin' >> "$GITHUB_PATH"
     - name: Set up Python 3.6
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v3
       with:
         python-version: 3.6
     - name: Install dependencies
       run: |
-        sudo wget -O /usr/bin/solc https://github.com/ethereum/solidity/releases/download/v0.5.7/solc-static-linux
-        sudo chmod +x /usr/bin/solc
+        pip install "solc-select>=v1.0.0b1"
+        solc-select use 0.5.7 --always-install
         pip install .
     - name: Run Tests
       env:
         TEST_TYPE: ${{ matrix.type }}
         GITHUB_ETHERSCAN: ${{ secrets.GITHUB_ETHERSCAN }}
+      shell: bash
       run: |
-        bash scripts/travis_test_${TEST_TYPE}.sh
+        bash "scripts/travis_test_${TEST_TYPE}.sh"

.github/workflows/linter.yml

@@ -33,7 +33,7 @@ jobs:
           cp pyproject.toml .github/linters
 
       - name: Lint everything else
-        uses: docker://github/super-linter:v3
+        uses: github/super-linter/[email protected]
         if: always()
         env:
           # run linter on everything to catch preexisting problems

.github/workflows/mypy.yml

@@ -33,7 +33,7 @@ jobs:
           cp mypy.ini .github/linters
 
       - name: Mypy
-        uses: docker://github/super-linter:v3
+        uses: github/super-linter/[email protected]
         if: always()
         env:
           # run linter on everything to catch preexisting problems

.github/workflows/pylint.yml

@@ -33,7 +33,7 @@ jobs:
           cp pyproject.toml .github/linters
 
       - name: Pylint
-        uses: docker://github/super-linter:v3
+        uses: github/super-linter/[email protected]
         if: always()
         env:
           # run linter on everything to catch preexisting problems
@@ -44,4 +44,3 @@ jobs:
           VALIDATE_PYTHON: true
           VALIDATE_PYTHON_PYLINT: true
           PYTHON_PYLINT_CONFIG_FILE: pyproject.toml
-

CONTRIBUTING.md

@@ -14,7 +14,7 @@ crytic-compile uses the pull request contribution model. Please make an account
 
 Some pull request guidelines:
 
-- Work from the [`dev`](https://github.com/crytic/crytic-compile/tree/dev) branch. We performed extensive tests prior to merging anything to `master`, working from `dev` will allow us to merge your work faster.
+- Work from the [`dev`](https://github.com/crytic/crytic-compile/tree/dev) branch. We perform extensive tests prior to merging anything to `master`, working from `dev` will allow us to merge your work faster.
 - Minimize irrelevant changes (formatting, whitespace, etc) to code that would otherwise not be touched by this patch. Save formatting or style corrections for a separate pull request that does not make any semantic changes.
 - When possible, large changes should be split up into smaller focused pull requests.
 - Fill out the pull request description with a summary of what your patch does, key changes that have been made, and any further points of discussion, if applicable.
@@ -35,7 +35,7 @@ To run them locally:
 - `darglint crytic_compile`
 
 
-We use pylint `2.8.2`, black `20.8b1`, mypy `0.812` and dargling `1.8.0`.
+We use pylint `2.13.4`, black `22.3.0`, mypy `0.942` and darglint `1.8.0`.
 
 ## Development Environment
 Instructions for installing a development version of crytic-compile can be found in our [wiki](https://github.com/crytic/crytic-compile/wiki/Developer-installation).

crytic_compile/compilation_unit.py

@@ -618,7 +618,7 @@ def _update_bytecode_with_libraries(
                 if library_found in libraries:
                     bytecode = re.sub(
                         re.escape(library_found),
-                        "{:040x}".format(int(libraries[library_found])),
+                        f"{libraries[library_found]:0>40x}",
                         bytecode,
                     )
         return bytecode

crytic_compile/crytic_compile.py

@@ -91,13 +91,13 @@ def __init__(self, target: Union[str, AbstractPlatform], **kwargs: str):
         # This is not memory optimized, but allow an offset lookup in O(1)
         # Because we frequently do this lookup in Slither during the AST parsing
         # We decided to favor the running time versus memory
-        self._cached_offset_to_line: Dict[Filename, Dict[int, Tuple[int, int]]] = dict()
+        self._cached_offset_to_line: Dict[Filename, Dict[int, Tuple[int, int]]] = {}
         # Lines are indexed from 1
         self._cached_line_to_offset: Dict[Filename, Dict[int, int]] = defaultdict(dict)
 
         # Return the line from the line number
         # Note: line 1 is at index 0
-        self._cached_line_to_code: Dict[Filename, List[bytes]] = dict()
+        self._cached_line_to_code: Dict[Filename, List[bytes]] = {}
 
         self._working_dir = Path.cwd()
 
@@ -259,7 +259,7 @@ def _get_cached_offset_to_line(self, file: Filename) -> None:
 
         source_code = self._cached_line_to_code[file]
         acc = 0
-        lines_delimiters: Dict[int, Tuple[int, int]] = dict()
+        lines_delimiters: Dict[int, Tuple[int, int]] = {}
         for line_number, x in enumerate(source_code):
             self._cached_line_to_offset[file][line_number + 1] = acc
 
@@ -630,7 +630,7 @@ def compile_all(target: str, **kwargs: str) -> List[CryticCompile]:
             compilations = load_from_zip(target)
         elif target.endswith(".zip.base64"):
             with tempfile.NamedTemporaryFile() as tmp:
-                with open(target) as target_file:
+                with open(target, encoding="base64") as target_file:
                     tmp.write(base64.b64decode(target_file.read()))
                     compilations = load_from_zip(tmp.name)
         else: