casper-network / casper-network/casper-sidecar

RESTful API to return the latest shutdown events

Open
#121 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
4
Forks
12
Avg merge
2d 3h
Merged PRs (30d)
1

Description

@hectoratcasper commented on [Tue Mar 14 2023](https://github.com/CasperLabs/Solution-Architecture/issues/74)

https://docs.google.com/document/d/1vBRbBmij9HHotY_8HIaUKk5a9Kq9Rqgxlk-UAE_F7xs/edit?pli=1

The Shutdown event is emitted when the node is about to shut down, usually for an upgrade. This causes a termination of the event stream since the server is shutting down. The SSE sidecar stores this event in the shutdown table:

![image](https://user-images.githubusercontent.com/102557486/225126051-22ee9099-9389-4aba-9a43-fbdd8a78f0ca.png)

We require a new RESTful API for this event that would allow operators to get the latest node shutdown events filter by a limit:

```
/shutdown?limit=10
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the SSE sidecar's shutdown table and the existing REST API entry points. Check how shutdown events are stored and how limit query parameters are handled, then expose the latest shutdown events at the requested /shutdown?limit endpoint and verify the response behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.