Develop a New Endpoint for Blockchain Activity Metrics

[SamantaCasal]

Description:

The new endpoint is designed to fetch detailed information about the activity of a specified blockchain or across all blockchains within a certain timeframe.
This endpoint will provide valuable insights into the volume in USD and the number of transactions occurring over user-defined periods.

Query Parameters:

startTime: The start date and time for the query period.
endTime: The end date and time for the query period.
sampleRate: The granularity of the data returned (hours, days, months, years).
chainId: The specific blockchain identifier. If this parameter is not specified, the endpoint should return data for all chains.

Proposed Data Structure:

[
  {
    "chain": "number",
    "time": "date and time",
    "count": "number",
    "volume": "number"
  }
]

Acceptance Criteria:

1. Endpoint Functionality: The new endpoint must accurately return data based on the specified query parameters, reflecting transaction counts and volumes in USD for the requested blockchain(s) and time period.

2. Granularity Support: The endpoint should effectively handle requests for different sampleRate values, ensuring data granularity matches the user's request (hourly, daily, monthly, yearly).

3. Chain Flexibility: If chainId is not specified in the request, the endpoint must compile and return data covering all supported blockchains, allowing for a comprehensive overview of the ecosystem.

4. Data Accuracy: Ensure the returned transaction counts and volumes are precise and reflective of actual blockchain activities within the specified timeframe.

5. Performance and Scalability: The implementation should not compromise the backend's performance. Ensure timely responses even when dealing with extensive datasets or covering large time spans.

6. Documentation: Provide clear and detailed documentation for this new endpoint, including descriptions of query parameters, the format of the response data, and example requests and responses. This documentation will assist developers in effectively utilizing the endpoint.

[SamantaCasal]

https://api.wormholescan.io/api/v1/x-chain-activity/tops?from=2024-03-04T00:00:00Z&to=2024-03-10T00:00:00Z&timespan=1d&sourceChain=1&targetChain=5&appId=PORTAL_TOKEN_BRIDGE