LucasLvy commented 2 months ago

Issue: Implement /get_historical_balance Endpoint

Description

We need to implement the /get_historical_balance endpoint in the Vault backend. This endpoint is responsible for retrieving the historical balance of an account.

Details

Method: GET
Path: /get_historical_balance
Summary: Get historical balance.

Request Parameters:

address: The StarkNet address for which the historical balance is to be retrieved.

Response:

Status Code: 200
Description: Successful retrieval of historical balance
Content Type: application/json
Body:

[
  {
    "date": "2024-03-29",
    "balance": "0x1234567890abcdef"
  },
  {
    "date": "2024-03-28",
    "balance": "0x234567890abcdef123"
  },
  ...
]

Notes:

The historical balance is represented as an array of objects, each containing a date and the corresponding balance in hexadecimal format.

Example

// Import necessary modules
import fastify from 'fastify';

// Create Fastify instance
const app = fastify({ logger: true });

// Define the get_historical_balance endpoint
app.get('/get_historical_balance', async (request, reply) => {
    try {
        // Logic to retrieve historical balance goes here

        // Return the historical balance
        return [
            {
                "date": "2024-03-29",
                "balance": "0x1234567890abcdef"
            },
            {
                "date": "2024-03-28",
                "balance": "0x234567890abcdef123"
            },
            ...
        ];
    } catch (error) {
        // Handle errors
        console.error('Error while retrieving historical balance:', error);
        return reply.status(500).send({ error: 'Internal Server Error' });
    }
});

Tasks:

[ ] Implement the /get_historical_balance endpoint.

EjembiEmmanuel commented 2 months ago

@LucasLvy can I work on this?