first commit

.coderabbit.yaml

@@ -0,0 +1,25 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+language: "en"
+early_access: false
+knowledge_base:
+  learnings:
+    scope: auto
+  issues:
+    scope: global
+reviews:
+  profile: "chill"
+  request_changes_workflow: false
+  high_level_summary: true
+  poem: false
+  review_status: true
+  collapse_walkthrough: true
+  auto_review:
+    enabled: true
+    ignore_title_keywords:
+      - "WIP"
+      - "DO NOT MERGE"
+    drafts: false
+    base_branches:
+      - dev
+chat:
+  auto_reply: true

.dockerignore

@@ -0,0 +1 @@
+Dockerfile

.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

.github/DISCUSSION_TEMPLATE/installation.yml

@@ -0,0 +1,38 @@
+--- 
+body: 
+  - 
+    attributes: 
+      label: "What operating system are you using?"
+    id: os
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      label: "How did you install slither?"
+      description: |
+        For example, using git or python's pip.
+    id: install-method
+    type: textarea
+    validations: 
+      required: true
+  - type: dropdown
+    id: python
+    attributes:
+      label: Do you have python added to your $PATH?
+      multiple: true
+      options:
+        - "Yes"
+        - "No"
+        - "Not sure"
+  - 
+    attributes: 
+      description: |
+          Please copy and paste any relevant log output. This 
+          will be automatically formatted into code, so no need for backticks.
+      render: shell
+      label: "Output of running `slither-doctor .`:"
+    id: logs
+labels: 
+  - installation-help
+title: "[Installation-Help]: "

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,54 @@
+--- 
+body: 
+  - 
+    attributes: 
+      value: |
+          Please check the issues tab to avoid duplicates, and 
+          confirm that the bug exists on the latest release (upgrade
+          by running `python3 -m pip install --upgrade slither-analyzer`).
+          
+          If you are having difficulty installing slither,
+          please head over to the "Discussions" page.
+          
+          Thanks for taking the time to fill out this bug report!
+    type: markdown
+  - 
+    attributes: 
+      label: "Describe the issue:"
+    id: what-happened
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: "It can be a github repo (preferred), etherscan link, or code snippet."
+      label: "Code example to reproduce the issue:"
+      placeholder: "`contract A {}`\n"
+    id: reproduce
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: |
+          What version of slither are you running?
+          Run `slither --version`
+      label: "Version:"
+    id: version
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: |
+          Please copy and paste any relevant log output. This 
+          will be automatically formatted into code, so no need for backticks.
+      render: shell
+      label: "Relevant log output:"
+    id: logs
+    type: textarea
+description: "File a bug report"
+labels: 
+  - bug-candidate
+name: "Bug Report"
+title: "[Bug-Candidate]: "

.github/ISSUE_TEMPLATE/false_negative.yml

@@ -0,0 +1,61 @@
+--- 
+body: 
+  - 
+    attributes: 
+      value: |
+          Please check the issues tab to avoid duplicates. 
+          Thanks for helping make Slither the best it can be!
+    type: markdown
+  - 
+    attributes: 
+      label: "What bug did Slither miss and which detector did you anticipate would catch it?"
+    id: what-happened
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes:
+      label: Frequency
+      description: How often do you run across this false negative?
+      options:
+        - Very Frequently
+        - Occasionally 
+        - Rarely
+        - Not sure
+    id: frequency
+    type: dropdown
+    validations:
+      required: true
+  - 
+    attributes: 
+      description: "It can be a github repo, etherscan link, or code snippet."
+      label: "Code example to reproduce the issue:"
+      placeholder: "`contract A {}`\n"
+    id: reproduce
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: |
+          What version of slither are you running? 
+          Run `slither --version`
+      label: "Version:"
+    id: version
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: |
+          Please copy and paste the result output. This 
+          will be automatically formatted into code, so no need for backticks.
+      render: shell
+      label: "Relevant log output:"
+    id: logs
+    type: textarea
+description: "Slither missed a bug it should find."
+labels: 
+  - false-negative
+name: False Negative
+title: "[False Negative]: "

.github/ISSUE_TEMPLATE/false_positive.yml

@@ -0,0 +1,61 @@
+--- 
+body: 
+  - 
+    attributes: 
+      value: |
+          Please check the issues tab to avoid duplicates. 
+          Thanks for helping make Slither the best it can be!
+    type: markdown
+  - 
+    attributes: 
+      label: "Describe the false alarm that Slither raise and how you know it's inaccurate:"
+    id: what-happened
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes:
+      label: Frequency
+      description: How often do you run across this false positive?
+      options:
+        - Very Frequently
+        - Occasionally 
+        - Rarely
+        - Not sure
+    id: frequency
+    type: dropdown
+    validations:
+      required: true
+  - 
+    attributes: 
+      description: "It can be a github repo, etherscan link, or code snippet."
+      label: "Code example to reproduce the issue:"
+      placeholder: "`contract A {}`\n"
+    id: reproduce
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: |
+          What version of slither are you running? 
+          Run `slither --version`
+      label: "Version:"
+    id: version
+    type: textarea
+    validations: 
+      required: true
+  - 
+    attributes: 
+      description: |
+          Please copy and paste the result output. This 
+          will be automatically formatted into code, so no need for backticks.
+      render: shell
+      label: "Relevant log output:"
+    id: logs
+    type: textarea
+description: "Slither warned of an issue that is not legitimate and does not need to be fixed."
+labels: 
+  - false-positive
+name: "False Positive"
+title: "[False-Positive]: "

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,17 @@
+---
+name: Feature request
+description: Suggest a feature
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please check the issues tab to avoid duplicates.
+
+        Thanks for providing feedback on Slither!
+  - type: textarea
+    attributes:
+      label: Describe the desired feature
+      description: Explain what the feature solves/ improves.
+    validations:
+      required: true

.github/actions/upload-coverage/action.yml

@@ -0,0 +1,30 @@
+# Derived from <https://github.com/pyca/cryptography/blob/SOME_REF/.github/actions/upload-coverage/action.yml>
+# Originally authored by the PyCA Cryptography maintainers, and licensed under
+# the terms of the BSD license:
+# <https://github.com/pyca/cryptography/blob/main/LICENSE.BSD>
+
+name: Upload Coverage
+description: Upload coverage files
+
+runs:
+  using: "composite"
+
+  steps:
+    # FIXME(jl): codecov has the option of including machine information in filename that would solve this unique naming
+    # issue more completely.
+    # This method has the limitation of 1 coverage file per run, limiting some coverage between online/offline tests.
+    - run: |
+        COVERAGE_UUID=$(python3 -c "import uuid; print(uuid.uuid4())")
+        echo "COVERAGE_UUID=${COVERAGE_UUID}" >> "$GITHUB_OUTPUT"
+        if [ -f .coverage ]; then
+          mv .coverage .coverage.${COVERAGE_UUID}
+        fi
+      id: coverage-uuid
+      shell: bash
+    - uses: actions/upload-artifact@v4
+      with:
+        name: coverage-data-${{ steps.coverage-uuid.outputs.COVERAGE_UUID }}
+        path: |
+          .coverage.*
+          *.lcov
+        if-no-files-found: ignore

.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+    - package-ecosystem: "github-actions"
+      directory: "/"
+      target-branch: "dev"
+      schedule:
+        interval: "weekly"

.github/scripts/integration_test_runner.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# used to pass --cov=$path and --cov-append to pytest
+if [ "$1" != "" ]; then
+    pytest "$1" tests/e2e/ -n auto
+    status_code=$?
+    python -m coverage report
+else
+    pytest tests/e2e/ -n auto
+    status_code=$?
+fi
+
+exit "$status_code"

.github/scripts/tool_test_runner.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# used to pass --cov=$path and --cov-append to pytest
+if [ "$1" != "" ]; then
+    pytest "$1" tests/tools
+    status_code=$?
+    python -m coverage report
+else
+    pytest tests/tools
+    status_code=$?
+fi
+
+exit "$status_code"

.github/scripts/unit_test_runner.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# used to pass --cov=$path and --cov-append to pytest
+if [ "$1" != "" ]; then
+    pytest "$1" tests/unit/ -n auto
+    status_code=$?
+    python -m coverage report
+else
+    pytest tests/unit/ -n auto
+    status_code=$?
+fi
+
+exit "$status_code"