fix(explorer): Batch stats endpoint should return an array of summarized batches information (#1721)

Co-authored-by: Julian Ventura <[email protected]>

Author: JulianVentura

explorer/config/config.exs

@@ -7,6 +7,13 @@
 # General application configuration
 import Config
 
+config :explorer,
+  batcher_submission_gas_cost: 125000,
+  aggregator_gas_cost: 330000,
+  additional_submission_gas_cost_per_proof: 2000,
+  aggregator_fee_percentage_multiplier: 125,
+  percentage_divider: 100
+
 config :explorer,
   generators: [timestamp_type: :utc_datetime],
   tracker_api_url: System.get_env("TRACKER_API_URL")

explorer/lib/explorer/models/batches.ex

@@ -164,23 +164,26 @@ defmodule Batches do
     end
   end
 
-  def get_last_24h_verified_proof_stats() do
-    minutes_in_a_day = 1440
-    threshold_datetime = DateTime.utc_now() |> DateTime.add(-1 * minutes_in_a_day, :minute) # Last 24 hours
+  # The following query was built by reading:
+  # - https://hexdocs.pm/ecto/Ecto.Query.html#module-fragments
+  # - https://www.postgresql.org/docs/9.1/functions-datetime.html#FUNCTIONS-DATETIME-TABLE
+  # - https://stackoverflow.com/questions/43288914/how-to-use-date-trunc-with-timezone-in-ecto-fragment-statement
+  # - https://glennjon.es/2016/09/24/elixir-ecto-how-to-group-and-count-records-by-week.html
+  def get_daily_verified_batches_summary() do
+    submission_constant_cost = Utils.constant_batch_submission_gas_cost()
+    additional_cost_per_proof = Utils.additional_batch_submission_gas_cost_per_proof()
+
+    query = Batches
+      |> where([b], b.is_verified == true)
+      |> group_by([b], fragment("DATE_TRUNC('day', ?)", b.response_timestamp))
+      |> select([b], %{
+        date: fragment("DATE_TRUNC('day', ?)::date", b.response_timestamp),
+        amount_of_proofs: sum(b.amount_of_proofs),
+        gas_cost: sum(fragment("? + ? * ?", ^submission_constant_cost, ^additional_cost_per_proof, b.amount_of_proofs))
+      })
+      |> order_by([b], fragment("DATE_TRUNC('day', ?)", b.response_timestamp))
 
-    query = from(b in Batches,
-      where: b.is_verified == true and b.submission_timestamp > ^threshold_datetime,
-      select: {sum(b.amount_of_proofs), avg(b.fee_per_proof)})
-
-    {amount_of_proofs, avg_fee_per_proof} = case Explorer.Repo.one(query) do
-      nil -> {0, 0.0}
-      result -> result
-    end
-
-    %{
-      amount_of_proofs: amount_of_proofs,
-      avg_fee_per_proof: avg_fee_per_proof
-    }
+    Explorer.Repo.all(query)
   end
 
   def insert_or_update(batch_changeset, proofs) do

explorer/lib/explorer_web/controllers/data_controller.ex

@@ -1,21 +1,12 @@
 defmodule ExplorerWeb.DataController do
   use ExplorerWeb, :controller
 
-  def verified_proofs_in_last_24_hours(conn, _params) do
-    %{
-      amount_of_proofs: amount_of_proofs,
-      avg_fee_per_proof: avg_fee_per_proof
-    } = Batches.get_last_24h_verified_proof_stats()
-
-    avg_fee_per_proof_usd =
-      case EthConverter.wei_to_usd_sf(avg_fee_per_proof, 2) do
-        {:ok, value} -> value
-        _ -> 0
-      end
+  def verified_batches_summary(conn, _params) do
+    batches_summary =
+      Batches.get_daily_verified_batches_summary()
 
     render(conn, :show, %{
-      amount_of_proofs: amount_of_proofs,
-      avg_fee_per_proof_usd: avg_fee_per_proof_usd
+      batches: batches_summary,
     })
   end
 end

explorer/lib/explorer_web/controllers/data_json.ex

@@ -1,11 +1,9 @@
 defmodule ExplorerWeb.DataJSON do
   def show(%{
-        amount_of_proofs: amount_of_proofs,
-        avg_fee_per_proof_usd: avg_fee_per_proof_usd
+        batches: batches,
       }) do
     %{
-      amount_of_proofs: amount_of_proofs,
-      avg_fee_per_proof_usd: avg_fee_per_proof_usd
+      batches: batches,
     }
   end
 end

explorer/lib/explorer_web/live/utils.ex

@@ -205,6 +205,12 @@ defmodule Utils do
                      _ -> 268_435_456
                    end)
 
+  @batcher_submission_gas_cost Application.compile_env(:explorer, :batcher_submission_gas_cost)
+  @aggregator_gas_cost Application.compile_env(:explorer, :aggregator_gas_cost)
+  @aggregator_fee_percentage_multiplier Application.compile_env(:explorer, :aggregator_fee_percentage_multiplier)
+  @percentage_divider Application.compile_env(:explorer, :percentage_divider)
+  @additional_submission_gas_cost_per_proof Application.compile_env(:explorer, :additional_submission_gas_cost_per_proof)
+
   def string_to_bytes32(hex_string) do
     # Remove the '0x' prefix
     hex =
@@ -409,4 +415,16 @@ defmodule Utils do
   def random_id(prefix) do
     prefix <> "_" <> (:crypto.strong_rand_bytes(8) |> Base.url_encode64(padding: false))
   end
+
+  def constant_batch_submission_gas_cost() do
+    trunc(
+      @aggregator_gas_cost * @aggregator_fee_percentage_multiplier /
+      @percentage_divider +
+      @batcher_submission_gas_cost
+    )
+  end
+
+  def additional_batch_submission_gas_cost_per_proof() do
+    @additional_submission_gas_cost_per_proof
+  end
 end

explorer/lib/explorer_web/router.ex

@@ -34,7 +34,7 @@ defmodule ExplorerWeb.Router do
 
   scope "/api", ExplorerWeb do
     pipe_through :api
-    get "/proofs_verified_last_24h", DataController, :verified_proofs_in_last_24_hours
+    get "/verified_batches_summary", DataController, :verified_batches_summary
   end
 
   scope "/", ExplorerWeb do