Solidityscan report API endpoint

[vbaranov]

Resolves #8907

Motivation

Adding API V2 endpoint for proxying request of Solidityscan report.

Changelog

New API v2 endpoint added:

api/v2/smart-contracts/#{contract_address_hash}/solidityscan-report

Sample success response:

{
    "scan_report": {
        "contract_address": "0x3d9819210A31b4961b30EF54bE2aeD79B9c9Cd3B",
        "contract_chain": "eth",
        "contract_platform": "blockscout",
        "contract_url": "https://eth.blockscout.com/address/0x3d9819210A31b4961b30EF54bE2aeD79B9c9Cd3B",
        "contractname": "Unitroller",
        "node_reference_id": null,
        "scan_status": "scan_done",
        "scan_summary": {
            "issue_severity_distribution": {
                "critical": 0,
                "gas": 95,
                "high": 1,
                "informational": 18,
                "low": 31,
                "medium": 1
            },
            "lines_analyzed_count": 2449,
            "scan_time_taken": 6,
            "score": "4.63",
            "score_v2": "92.57",
            "threat_score": "88.89"
        },
        "scanner_reference_url": "https://solidityscan.com/quickscan/0x3d9819210A31b4961b30EF54bE2aeD79B9c9Cd3B/blockscout/eth?ref=blockscout"
    },
    "status": "success"
}

Sample failed response:

{
    "message": "...",
    "status": "error"
}

Checklist for your Pull Request (PR)

• I added an entry to CHANGELOG.md with this PR Solidityscan envs docs#200
• If I added new functionality, I added tests covering it.
• If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
• I checked whether I should update the docs and did so by submitting a PR to https://github.com/blockscout/docs
• If I added/changed/removed ENV var, I submitted a PR to https://github.com/blockscout/docs to update the list of env vars at https://github.com/blockscout/docs/blob/master/for-developers/information-and-settings/env-variables.md and I updated the version to master in the Version column. Changes will be reflected in this table: https://docs.blockscout.com/for-developers/information-and-settings/env-variables.
• If I add new indices into DB, I checked, that they are not redundant with PGHero or other tools

[nikitosing]

Let's rename it to quickscan_url

[vbaranov]

What is the purpose? What if they change the api path? I'd say we shouldn't depend on their naming in our intertnal namings.

[nikitosing]

Usually base_url in our modules stands for the base path to the api (https://api.solidityscan.com/api/v1). In this case base_url doesn't suit to this paradigm, therefore I suggested to rename the function

[nikitosing]

In API v2 we usually state all mismatched with patters in BlockScoutWeb.API.V2.FallbackController. Most likely all of the patterns you stated, already exist in FallbackController

[vbaranov]

Ok, extended fallback controller with new responses in 381a6eb

[sl1depengwyn]

It seems that Address.is_smart_contract/1 may return nil as well

[vbaranov]

Good catch. Fixed in 48ac396.

[sl1depengwyn]

Maybe we will pass function instead of list to not to execute request if rust verifier is disabled?
Like this

  defp fetch_solc_versions do
    fetch_compiler_versions(&RustVerifierInterface.get_versions_list/0, :solc)
  end

  defp fetch_vyper_versions do
    fetch_compiler_versions(&RustVerifierInterface.vyper_get_versions_list/0, :vyper)
  end

  defp fetch_compiler_versions(compiler_list_fn, compiler_type) do
    if RustVerifierInterface.enabled?() do
      compiler_list_fn.()
    else
      headers = [{"Content-Type", "application/json"}]

      case HTTPoison.get(source_url(compiler_type), headers) do
        {:ok, %{status_code: 200, body: body}} ->
          {:ok, format_data(body, compiler_type)}

        {:ok, %{status_code: _status_code, body: body}} ->
          {:error, Helper.decode_json(body)["error"]}

        {:error, %{reason: reason}} ->
          {:error, reason}
      end
    end
  end

[vbaranov]

Makes sense. Applied in 48ac396

[sl1depengwyn]

What do you think about these dialyzer warnings? It seems that HTTPoison.get may return only %Response{} or %Error{} indeed, maybe we can remove this clauses https://github.com/blockscout/blockscout/blob/vb-solidityscan-support/apps/explorer/lib/explorer/exchange_rates/source.ex#L134-L138?

[vbaranov]

I agree. Implemented in 48ac396