Skip to content

feat: add /status endpoint#817

Merged
sergerad merged 1 commit intonextfrom
tomasarrachea-status-endpoint
May 12, 2025
Merged

feat: add /status endpoint#817
sergerad merged 1 commit intonextfrom
tomasarrachea-status-endpoint

Conversation

@TomasArrachea
Copy link
Collaborator

@TomasArrachea TomasArrachea commented Apr 30, 2025

Closes #794.

This PR adds a new /status endpoint on the store, block-producer and RPC components. The RPC endpoint hits the store and block-producer and aggregates their status into a single status response:

{
    "version": "0.9.0",
    "store_status": {
        "version": "0.9.0",
        "status": "connected",
        "chain_tip": 684
    },
    "block_producer_status": {
        "version": "0.9.0",
        "status": "connected"
    }
}

This endpoint can be easily accesed using Postman or grpcurl.

To run using grpcurl:

grpcurl -import-path ./proto/proto -proto rpc.proto -plaintext localhost:57291 rpc.Api.Status

@TomasArrachea TomasArrachea force-pushed the tomasarrachea-status-endpoint branch from f05088d to 0d6be4b Compare May 5, 2025 19:38
@TomasArrachea TomasArrachea force-pushed the tomasarrachea-status-endpoint branch from 73aef29 to 75f6ea4 Compare May 6, 2025 13:56
@TomasArrachea TomasArrachea marked this pull request as ready for review May 6, 2025 14:12
@TomasArrachea TomasArrachea requested review from bobbinth and sergerad May 6, 2025 14:33
Copy link
Collaborator

@sergerad sergerad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Thanks for including the grpcurl command. Branch works as expected 👍

Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thank you!

We should also update documentation (at least here but maybe also worth mentioning it in other places).

@sergerad sergerad merged commit 79676a7 into next May 12, 2025
6 checks passed
@sergerad sergerad deleted the tomasarrachea-status-endpoint branch May 12, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add status page for miden node

3 participants