Merge pull request #3719 from poanetwork/vb-rename-ethprice-api-endpoint

Rename ethprice API endpoint
blockscout · Mar 19, 2021 · 900c36f · 900c36f
2 parents cd4280b + 5b5c4d4
commit 900c36f
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 42 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,7 @@
 - [#3577](https://github.com/poanetwork/blockscout/pull/3577) - Eliminate GraphiQL page XSS attack
 
 ### Chore
+- [#3719](https://github.com/poanetwork/blockscout/pull/3719) - Rename ethprice API endpoint
 - [#3717](https://github.com/poanetwork/blockscout/pull/3717) - Update alpine-elixir-phoenix 1.11.3
 - [#3714](https://github.com/poanetwork/blockscout/pull/3714) - Application announcements management: whole explorer, staking dapp
 - [#3712](https://github.com/poanetwork/blockscout/pull/3712) - POSDAO refactoring: use pool ID instead of staking address

diff --git a/apps/block_scout_web/lib/block_scout_web/controllers/api/rpc/stats_controller.ex b/apps/block_scout_web/lib/block_scout_web/controllers/api/rpc/stats_controller.ex
@@ -59,11 +59,11 @@ defmodule BlockScoutWeb.API.RPC.StatsController do
     render(conn, "coinsupply.json", total_supply: cached_coin_total_supply)
   end
 
-  def ethprice(conn, _params) do
+  def coinprice(conn, _params) do
     symbol = Application.get_env(:explorer, :coin)
     rates = ExchangeRates.lookup(symbol)
 
-    render(conn, "ethprice.json", rates: rates)
+    render(conn, "coinprice.json", rates: rates)
   end
 
   defp fetch_contractaddress(params) do

diff --git a/apps/block_scout_web/lib/block_scout_web/etherscan.ex b/apps/block_scout_web/lib/block_scout_web/etherscan.ex
@@ -313,14 +313,14 @@ defmodule BlockScoutWeb.Etherscan do
 
   @stats_coinsupply_example_value 101_959_776.3115
 
-  @stats_ethprice_example_value %{
+  @stats_coinprice_example_value %{
     "status" => "1",
     "message" => "OK",
     "result" => %{
-      "ethbtc" => "0.03246",
-      "ethbtc_timestamp" => "1537212510",
-      "ethusd" => "204",
-      "ethusd_timestamp" => "1537212513"
+      "coin_btc" => "0.03246",
+      "coin_btc_timestamp" => "1537212510",
+      "coin_usd" => "204",
+      "coin_usd_timestamp" => "1537212513"
     }
   }
 
@@ -1087,25 +1087,25 @@ defmodule BlockScoutWeb.Etherscan do
     }
   }
 
-  @eth_price_model %{
-    name: "EthPrice",
+  @coin_price_model %{
+    name: "CoinPrice",
     fields: %{
-      ethbtc: %{
-        type: "ethbtc",
-        definition: &__MODULE__.ethbtc_type_definition/1,
+      coin_btc: %{
+        type: "coin_btc",
+        definition: &__MODULE__.coin_btc_type_definition/1,
         example: ~s("0.03161")
       },
-      ethbtc_timestamp: %{
+      coin_btc_timestamp: %{
         type: "timestamp",
         definition: "Last updated timestamp.",
         example: ~s("1537234460")
       },
-      ethusd: %{
-        type: "ethusd",
-        definition: &__MODULE__.ethusd_type_definition/1,
+      coin_usd: %{
+        type: "coin_usd",
+        definition: &__MODULE__.coin_usd_type_definition/1,
         example: ~s("197.57")
       },
-      ethusd_timestamp: %{
+      coin_usd_timestamp: %{
         type: "timestamp",
         definition: "Last updated timestamp.",
         example: ~s("1537234460")
@@ -2021,24 +2021,24 @@ defmodule BlockScoutWeb.Etherscan do
     ]
   }
 
-  @stats_ethprice_action %{
-    name: "ethprice",
-    description: "Get latest price in USD and BTC.",
+  @stats_coinprice_action %{
+    name: "coinprice",
+    description: "Get latest price of native coin in USD and BTC.",
     required_params: [],
     optional_params: [],
     responses: [
       %{
         code: "200",
         description: "successful operation",
-        example_value: Jason.encode!(@stats_ethprice_example_value),
+        example_value: Jason.encode!(@stats_coinprice_example_value),
         model: %{
           name: "Result",
           fields: %{
             status: @status_type,
             message: @message_type,
             result: %{
               type: "model",
-              model: @eth_price_model
+              model: @coin_price_model
             }
           }
         }
@@ -2538,7 +2538,7 @@ defmodule BlockScoutWeb.Etherscan do
       @stats_ethsupplyexchange_action,
       @stats_ethsupply_action,
       @stats_coinsupply_action,
-      @stats_ethprice_action
+      @stats_coinprice_action
     ]
   }
 
@@ -2586,11 +2586,11 @@ defmodule BlockScoutWeb.Etherscan do
       "One #{coin} is defined as being 10<sup>18</sup> Wei."
   end
 
-  def ethbtc_type_definition(coin) do
+  def coin_btc_type_definition(coin) do
     "#{coin} price in Bitcoin."
   end
 
-  def ethusd_type_definition(coin) do
+  def coin_usd_type_definition(coin) do
     "#{coin} price in US dollars."
   end
 end
diff --git a/apps/block_scout_web/lib/block_scout_web/views/api/rpc/stats_view.ex b/apps/block_scout_web/lib/block_scout_web/views/api/rpc/stats_view.ex
@@ -19,7 +19,7 @@ defmodule BlockScoutWeb.API.RPC.StatsView do
     RPCView.render("show_value.json", data: total_supply)
   end
 
-  def render("ethprice.json", %{rates: rates}) do
+  def render("coinprice.json", %{rates: rates}) do
     RPCView.render("show.json", data: prepare_rates(rates))
   end
 
@@ -31,10 +31,10 @@ defmodule BlockScoutWeb.API.RPC.StatsView do
     timestamp = rates.last_updated |> DateTime.to_unix() |> to_string()
 
     %{
-      "ethbtc" => to_string(rates.btc_value),
-      "ethbtc_timestamp" => timestamp,
-      "ethusd" => to_string(rates.usd_value),
-      "ethusd_timestamp" => timestamp
+      "coin_btc" => to_string(rates.btc_value),
+      "coin_btc_timestamp" => timestamp,
+      "coin_usd" => to_string(rates.usd_value),
+      "coin_usd_timestamp" => timestamp
     }
   end
 end
diff --git a/apps/block_scout_web/test/block_scout_web/controllers/api/rpc/stats_controller_test.exs b/apps/block_scout_web/test/block_scout_web/controllers/api/rpc/stats_controller_test.exs
@@ -140,7 +140,7 @@ defmodule BlockScoutWeb.API.RPC.StatsControllerTest do
   #   end
   # end
 
-  describe "ethprice" do
+  describe "coinprice" do
     setup :set_mox_global
 
     setup do
@@ -179,16 +179,16 @@ defmodule BlockScoutWeb.API.RPC.StatsControllerTest do
 
       params = %{
         "module" => "stats",
-        "action" => "ethprice"
+        "action" => "coinprice"
       }
 
       expected_timestamp = eth.last_updated |> DateTime.to_unix() |> to_string()
 
       expected_result = %{
-        "ethbtc" => to_string(eth.btc_value),
-        "ethbtc_timestamp" => expected_timestamp,
-        "ethusd" => to_string(eth.usd_value),
-        "ethusd_timestamp" => expected_timestamp
+        "coin_btc" => to_string(eth.btc_value),
+        "coin_btc_timestamp" => expected_timestamp,
+        "coin_usd" => to_string(eth.usd_value),
+        "coin_usd_timestamp" => expected_timestamp
       }
 
       assert response =
@@ -199,7 +199,7 @@ defmodule BlockScoutWeb.API.RPC.StatsControllerTest do
       assert response["result"] == expected_result
       assert response["status"] == "1"
       assert response["message"] == "OK"
-      assert :ok = ExJsonSchema.Validator.validate(ethprice_schema(), response)
+      assert :ok = ExJsonSchema.Validator.validate(coinprice_schema(), response)
     end
   end
 
@@ -221,14 +221,14 @@ defmodule BlockScoutWeb.API.RPC.StatsControllerTest do
     })
   end
 
-  defp ethprice_schema do
+  defp coinprice_schema do
     resolve_schema(%{
       "type" => "object",
       "properties" => %{
-        "ethbtc" => %{"type" => "string"},
-        "ethbtc_timestamp" => %{"type" => "string"},
-        "ethusd" => %{"type" => "string"},
-        "ethusd_timestamp" => %{"type" => "string"}
+        "coin_btc" => %{"type" => "string"},
+        "coin_btc_timestamp" => %{"type" => "string"},
+        "coin_usd" => %{"type" => "string"},
+        "coin_usd_timestamp" => %{"type" => "string"}
       }
     })
   end