refactor(explored-types): rename block metrics APIs

SiaFoundation · Dec 16, 2024 · 0d6b8d0 · 0d6b8d0
1 parent 95f51d3
commit 0d6b8d0
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 39 deletions.
diff --git a/.changeset/shiny-pugs-punch.md b/.changeset/shiny-pugs-punch.md
@@ -0,0 +1,7 @@
+---
+'@siafoundation/explored-js': minor
+'@siafoundation/explored-react': minor
+'@siafoundation/explored-types': minor
+---
+
+Rename block metrics APIs.
diff --git a/libs/explored-js/src/api.ts b/libs/explored-js/src/api.ts
@@ -56,14 +56,14 @@ import {
   HostByPubkeyParams,
   HostByPubkeyPayload,
   HostByPubkeyResponse,
-  metricsRoute,
-  MetricsParams,
-  MetricsPayload,
-  MetricsResponse,
-  metricsByIDRoute,
-  MetricsByIDParams,
-  MetricsByIDPayload,
-  MetricsByIDResponse,
+  blockMetricsRoute,
+  BlockMetricsParams,
+  BlockMetricsPayload,
+  BlockMetricsResponse,
+  blockMetricsByIDRoute,
+  BlockMetricsByIDParams,
+  BlockMetricsByIDPayload,
+  BlockMetricsByIDResponse,
   OutputSiacoinParams,
   OutputSiacoinPayload,
   OutputSiacoinResponse,
@@ -253,16 +253,16 @@ export function Explored({
       ContractRevisionsResponse
     >(axios, 'get', contractRevisionsRoute),
     // Metrics
-    metrics: buildRequestHandler<
-      MetricsParams,
-      MetricsPayload,
-      MetricsResponse
-    >(axios, 'get', metricsRoute),
-    metricsByID: buildRequestHandler<
-      MetricsByIDParams,
-      MetricsByIDPayload,
-      MetricsByIDResponse
-    >(axios, 'get', metricsByIDRoute),
+    blockMetrics: buildRequestHandler<
+      BlockMetricsParams,
+      BlockMetricsPayload,
+      BlockMetricsResponse
+    >(axios, 'get', blockMetricsRoute),
+    blockMetricsByID: buildRequestHandler<
+      BlockMetricsByIDParams,
+      BlockMetricsByIDPayload,
+      BlockMetricsByIDResponse
+    >(axios, 'get', blockMetricsByIDRoute),
     // Search
     searchResultType: buildRequestHandler<
       SearchResultTypeParams,

diff --git a/libs/explored-react/src/hooks.ts b/libs/explored-react/src/hooks.ts
@@ -8,6 +8,12 @@ import {
   AddressSiafundUTXOsParams,
   AddressSiafundUTXOsResponse,
   addressSiafundUTXOsRoute,
+  BlockMetricsByIDParams,
+  BlockMetricsByIDResponse,
+  blockMetricsByIDRoute,
+  BlockMetricsParams,
+  BlockMetricsResponse,
+  blockMetricsRoute,
   ConsensusNetworkParams,
   ConsensusNetworkResponse,
   consensusNetworkRoute,
@@ -33,12 +39,6 @@ import {
   HostByPubkeyParams,
   HostByPubkeyResponse,
   hostByPubkeyRoute,
-  MetricsByIDParams,
-  MetricsByIDResponse,
-  metricsByIDRoute,
-  MetricsParams,
-  MetricsResponse,
-  metricsRoute,
   OutputSiacoinParams,
   OutputSiacoinResponse,
   outputSiacoinRoute,
@@ -327,19 +327,21 @@ export function useContractRevisions(
 
 // Metrics
 
-export function useMetrics(args: HookArgsSwr<MetricsParams, MetricsResponse>) {
+export function useBlockMetrics(
+  args: HookArgsSwr<BlockMetricsParams, BlockMetricsResponse>
+) {
   return useGetSwr({
     ...args,
-    route: metricsRoute,
+    route: blockMetricsRoute,
   })
 }
 
-export function useMetricsByID(
-  args: HookArgsSwr<MetricsByIDParams, MetricsByIDResponse>
+export function useBlockMetricsByID(
+  args: HookArgsSwr<BlockMetricsByIDParams, BlockMetricsByIDResponse>
 ) {
   return useGetSwr({
     ...args,
-    route: metricsByIDRoute,
+    route: blockMetricsByIDRoute,
   })
 }
 

diff --git a/libs/explored-types/src/api.ts b/libs/explored-types/src/api.ts
@@ -3,6 +3,7 @@ import {
   AddressBalance,
   Block,
   BlockID,
+  BlockMetrics,
   ChainIndex,
   ConsensusNetwork,
   ConsensusState,
@@ -15,7 +16,6 @@ import {
   ExplorerTransaction,
   FileContractID,
   Hash256,
-  Metrics,
   Peer,
   PublicKey,
   SearchResultType,
@@ -205,16 +205,16 @@ export type ContractRevisionsResponse = ExplorerFileContract[]
 // Metrics
 
 // Returns the most recent metrics about Sia.
-export const metricsRoute = '/metrics/block'
-export type MetricsParams = void
-export type MetricsPayload = void
-export type MetricsResponse = Metrics
+export const blockMetricsRoute = '/metrics/block'
+export type BlockMetricsParams = void
+export type BlockMetricsPayload = void
+export type BlockMetricsResponse = BlockMetrics
 
 // Returns various metrics about Sia at the time of the given block ID.
-export const metricsByIDRoute = '/metrics/block/:id'
-export type MetricsByIDParams = { id: BlockID }
-export type MetricsByIDPayload = void
-export type MetricsByIDResponse = Metrics
+export const blockMetricsByIDRoute = '/metrics/block/:id'
+export type BlockMetricsByIDParams = { id: BlockID }
+export type BlockMetricsByIDPayload = void
+export type BlockMetricsByIDResponse = BlockMetrics
 
 // Search
 

diff --git a/libs/explored-types/src/types.ts b/libs/explored-types/src/types.ts
@@ -65,7 +65,7 @@ export type Event = {
   data: string
 }
 
-export type Metrics = {
+export type BlockMetrics = {
   index: ChainIndex
   difficulty: string
   totalHosts: number