Merge pull request #2588 from poanetwork/ab-add-verification-submission-comment

add verification submission comment

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Current
 
 ### Features
+- [#2588](https://github.com/poanetwork/blockscout/pull/2588) - add verification submission comment
 - [#2505](https://github.com/poanetwork/blockscout/pull/2505) - support POA Network emission rewards
 - [#2636](https://github.com/poanetwork/blockscout/pull/2636) - Execute all address' transactions page queries in parallel
 - [#2596](https://github.com/poanetwork/blockscout/pull/2596) - support AuRa's empty step reward type

apps/block_scout_web/lib/block_scout_web/templates/address_contract/index.html.eex

@@ -66,7 +66,7 @@
             </button>
           </div>
           <div class="tile tile-muted mb-4">
-            <pre class="pre-scrollable line-numbers" data-activate-highlight><code class="solidity"><%= for {line, number} <- contract_lines_with_index(@address.smart_contract.contract_source_code) do %><div data-line-number="<%= number %>"><%= line %></div><% end %></code></pre>
+            <pre class="pre-scrollable line-numbers" data-activate-highlight><code class="solidity"><%= for {line, number} <- contract_lines_with_index(@address.smart_contract.contract_source_code, @address.smart_contract.inserted_at) do %><div data-line-number="<%= number %>"><%= line %></div><% end %></code></pre>
           </div>
         </section>
 

apps/block_scout_web/lib/block_scout_web/views/address_contract_view.ex

@@ -2,7 +2,7 @@ defmodule BlockScoutWeb.AddressContractView do
   use BlockScoutWeb, :view
 
   alias ABI.{FunctionSelector, TypeDecoder}
-  alias Explorer.Chain.{Address, Data, InternalTransaction}
+  alias Explorer.Chain.{Address, Data, InternalTransaction, SmartContract}
 
   def render("scripts.html", %{conn: conn}) do
     render_scripts(conn, "address_contract/code_highlighting.js")
@@ -63,8 +63,11 @@ defmodule BlockScoutWeb.AddressContractView do
     end)
   end
 
-  def contract_lines_with_index(contract_source_code) do
-    contract_lines = String.split(contract_source_code, "\n")
+  def contract_lines_with_index(source_code, inserted_at \\ nil) do
+    contract_lines =
+      source_code
+      |> String.split("\n")
+      |> SmartContract.add_submitted_comment(inserted_at)
 
     max_digits =
       contract_lines

apps/block_scout_web/test/block_scout_web/controllers/api/rpc/contract_controller_test.exs

@@ -1,6 +1,6 @@
 defmodule BlockScoutWeb.API.RPC.ContractControllerTest do
   use BlockScoutWeb.ConnCase
-  alias Explorer.Factory
+  alias Explorer.{Chain, Factory}
 
   describe "listcontracts" do
     setup do
@@ -450,7 +450,9 @@ defmodule BlockScoutWeb.API.RPC.ContractControllerTest do
       expected_result = [
         %{
           "Address" => to_string(contract.address_hash),
-          "SourceCode" => contract.contract_source_code,
+          "SourceCode" =>
+            "/**\n* Submitted for verification at blockscout.com on #{contract.inserted_at}\n*/\n" <>
+              contract.contract_source_code,
           "ABI" => Jason.encode!(contract.abi),
           "ContractName" => contract.name,
           "CompilerVersion" => contract.compiler_version,
@@ -496,9 +498,13 @@ defmodule BlockScoutWeb.API.RPC.ContractControllerTest do
         |> get("/api", params)
         |> json_response(200)
 
+      verified_contract = Chain.address_hash_to_smart_contract(contract_address.hash)
+
       expected_result = %{
         "Address" => to_string(contract_address.hash),
-        "SourceCode" => contract_code_info.source_code,
+        "SourceCode" =>
+          "/**\n* Submitted for verification at blockscout.com on #{verified_contract.inserted_at}\n*/\n" <>
+            contract_code_info.source_code,
         "ABI" => Jason.encode!(contract_code_info.abi),
         "ContractName" => contract_code_info.name,
         "CompilerVersion" => contract_code_info.version,
@@ -563,8 +569,14 @@ defmodule BlockScoutWeb.API.RPC.ContractControllerTest do
 
       result = response["result"]
 
+      verified_contract = Chain.address_hash_to_smart_contract(contract_address.hash)
+
       assert result["Address"] == to_string(contract_address.hash)
-      assert result["SourceCode"] == contract_source_code
+
+      assert result["SourceCode"] ==
+               "/**\n* Submitted for verification at blockscout.com on #{verified_contract.inserted_at}\n*/\n" <>
+                 contract_source_code
+
       assert result["ContractName"] == name
       assert result["DecompiledSourceCode"] == "Contract source code not decompiled."
       assert result["DecompilerVersion"] == ""

apps/block_scout_web/test/block_scout_web/views/address_contract_view_test.exs

@@ -38,22 +38,25 @@ defmodule BlockScoutWeb.AddressContractViewTest do
       result = AddressContractView.contract_lines_with_index(code)
 
       assert result == [
-               {"pragma solidity >=0.4.22 <0.6.0;", " 1"},
-               {"", " 2"},
-               {"struct Proposal {", " 3"},
-               {"  uint voteCount;", " 4"},
-               {"}", " 5"},
-               {"", " 6"},
-               {"address chairperson;", " 7"},
-               {"mapping(address => Voter) voters;", " 8"},
-               {"Proposal[] proposals;", " 9"},
-               {"", "10"},
-               {"constructor(uint8 _numProposals) public {", "11"},
-               {"  chairperson = msg.sender;", "12"},
-               {"  voters[chairperson].weight = 1;", "13"},
-               {"  proposals.length = _numProposals;", "14"},
-               {"}", "15"},
-               {"", "16"}
+               {"/**", " 1"},
+               {"* Submitted for verification at blockscout.com on ", " 2"},
+               {"*/", " 3"},
+               {"pragma solidity >=0.4.22 <0.6.0;", " 4"},
+               {"", " 5"},
+               {"struct Proposal {", " 6"},
+               {"  uint voteCount;", " 7"},
+               {"}", " 8"},
+               {"", " 9"},
+               {"address chairperson;", "10"},
+               {"mapping(address => Voter) voters;", "11"},
+               {"Proposal[] proposals;", "12"},
+               {"", "13"},
+               {"constructor(uint8 _numProposals) public {", "14"},
+               {"  chairperson = msg.sender;", "15"},
+               {"  voters[chairperson].weight = 1;", "16"},
+               {"  proposals.length = _numProposals;", "17"},
+               {"}", "18"},
+               {"", "19"}
              ]
     end
 
@@ -66,7 +69,17 @@ defmodule BlockScoutWeb.AddressContractViewTest do
 
     test "returns a list of tuples and the first element is just a line from the original string" do
       result = AddressContractView.contract_lines_with_index("a\nb\nc\nd\ne")
-      assert Enum.map(result, fn {line, _number} -> line end) == ["a", "b", "c", "d", "e"]
+
+      assert Enum.map(result, fn {line, _number} -> line end) == [
+               "/**",
+               "* Submitted for verification at blockscout.com on ",
+               "*/",
+               "a",
+               "b",
+               "c",
+               "d",
+               "e"
+             ]
     end
   end
 end

apps/explorer/lib/explorer/chain.ex

@@ -2592,8 +2592,26 @@ defmodule Explorer.Chain do
   @spec address_hash_to_address_with_source_code(Hash.Address.t()) :: Address.t() | nil
   def address_hash_to_address_with_source_code(address_hash) do
     case Repo.get(Address, address_hash) do
-      nil -> nil
-      address -> Repo.preload(address, [:smart_contract, :decompiled_smart_contracts])
+      nil ->
+        nil
+
+      address ->
+        address_with_smart_contract = Repo.preload(address, [:smart_contract, :decompiled_smart_contracts])
+
+        if address_with_smart_contract.smart_contract do
+          formatted_code =
+            SmartContract.add_submitted_comment(
+              address_with_smart_contract.smart_contract.contract_source_code,
+              address_with_smart_contract.smart_contract.inserted_at
+            )
+
+          %{
+            address_with_smart_contract
+            | smart_contract: %{address_with_smart_contract.smart_contract | contract_source_code: formatted_code}
+          }
+        else
+          address_with_smart_contract
+        end
     end
   end
 

apps/explorer/lib/explorer/chain/smart_contract.ex

@@ -271,6 +271,45 @@ defmodule Explorer.Chain.SmartContract do
     |> add_error(:contract_source_code, error_message(error))
   end
 
+  def add_submitted_comment(code, inserted_at) when is_binary(code) do
+    code
+    |> String.split("\n")
+    |> add_submitted_comment(inserted_at)
+    |> Enum.join("\n")
+  end
+
+  def add_submitted_comment(contract_lines, inserted_at) when is_list(contract_lines) do
+    etherscan_index =
+      Enum.find_index(contract_lines, fn line ->
+        String.contains?(line, "Submitted for verification at Etherscan.io")
+      end)
+
+    blockscout_index =
+      Enum.find_index(contract_lines, fn line ->
+        String.contains?(line, "Submitted for verification at blockscout.com")
+      end)
+
+    cond do
+      etherscan_index && blockscout_index ->
+        List.replace_at(contract_lines, etherscan_index, "*")
+
+      etherscan_index && !blockscout_index ->
+        List.replace_at(
+          contract_lines,
+          etherscan_index,
+          "* Submitted for verification at blockscout.com on #{inserted_at}"
+        )
+
+      !etherscan_index && !blockscout_index ->
+        header = ["/**", "* Submitted for verification at blockscout.com on #{inserted_at}", "*/"]
+
+        header ++ contract_lines
+
+      true ->
+        contract_lines
+    end
+  end
+
   defp upsert_contract_methods(%Ecto.Changeset{changes: %{abi: abi}} = changeset) do
     ContractMethod.upsert_from_abi(abi, get_field(changeset, :address_hash))