minimal API #95

Closed massa-bot closed 2 years ago

In GitLab by @sebf

In order to debug or get info on the internal states of the protocol, we need an API that will be accessed at first from the command line (command line issue: https://gitlab.com/massalabs/massa-network/-/issues/96).

API has the following endpoints:

[x] Block(hash) : return all block details -> (hash, thread, slot, parents, creation node,...)
[x] BlockInterval(starttime, endtime): return all block hash found in the time interval -> hash list
[x] GraphInterval(starttime, endtime): return all block info needed to reconstruct the graph found in the time interval -> list of (hash, thread, slot, status, parents hash)
[x] CurrentParents(): return the current best parents -> T*(hash, thread, slot)
[x] LastFinal(): return the last final block of each thread -> T*(hash, thread, slot)
[x] Cliques(): return the number of cliques and the current cliques (hash set set)
[x] NetworkInfo(): return network information: own IP address, connected peers (IP)
[x] State(): returns a summary of the current state: time, last final block (hash, thread, slot, timestamp), nb cliques, nb connected nodes
[x] LastStale(): return the last stale blocks found -> (hash, thread, slot) list
[x] LastInvalid(): return the last invalid blocks found -> (hash, thread, slot, reason) list
[x] StakerInfo(address) : return staker info from staker address (pubkey hash) -> (blocks created, next slots where address is selected)

Later:

[ ] LastInvalid(): detail reason
[ ] StakingInfo(): return info about rolls, seeds, snapshots, cycles
[ ] NetworkInfo(): also connection status, connections usage, average upload and download bandwidth used for headers, operations, syncing
[ ] CPUInfo(): return info about average cpu usage, log peak usage, use for sig verification vs cliques etc
[ ] StorageInfo(): return info about disk usage, ram usage, ledger vs headers vs operations, etc
[ ] State(): also recent miss rate, cycle, overall sanity (up-to-date, forks,...)

Framework

rocket = no, too many things for what we want
tide = no, async-std
actix = maybe also a bit too advanced for our simple api
warp = minimal for our purpose, builds on top of hyper / tokio, looks good !

https://github.com/seanmonstar/warp

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @damip

changed the description

In GitLab by @pdelrieu

created merge request !100 to address this issue

In GitLab by @pdelrieu

mentioned in merge request !100

In GitLab by @AureliaDolo

changed the description

In GitLab by @AureliaDolo

marked the task Block(hash) : return all block details -> (hash, thread, slot, parents, creation node,...) as completed

In GitLab by @AureliaDolo

marked the task BlockInterval(starttime, endtime): return all block hash found in the time interval -> hash list as completed

In GitLab by @AureliaDolo

marked the task GraphInterval(starttime, endtime): return all block info needed to reconstruct the graph found in the time interval -> list of (hash, thread, slot, status, parents hash) as completed

In GitLab by @AureliaDolo

marked the task *CurrentParents(): return the current best parents -> T(hash, thread, slot)** as completed

In GitLab by @AureliaDolo

marked the task *LastFinal(): return the last final block of each thread -> T(hash, thread, slot)** as completed

In GitLab by @AureliaDolo

marked the task Cliques(): return the number of cliques and the current cliques (hash set set) as completed

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @AureliaDolo

marked the task NetworkInfo(): return network information: own IP address, connected peers (IP) as completed

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @sebf

changed the description

In GitLab by @AureliaDolo

mentioned in merge request !105

In GitLab by @AureliaDolo

marked the task State(): returns a summary of the current state: time, last final block (hash, thread, slot, timestamp), nb cliques, nb connected nodes, recent miss rate as completed

In GitLab by @AureliaDolo

changed the description

In GitLab by @AureliaDolo

changed the description

In GitLab by @AureliaDolo

changed the description

In GitLab by @AureliaDolo

marked the task StakerInfo(address) : return staker info from staker address (pubkey hash) -> (blocks created, next slots where address is selected) as completed

In GitLab by @damip

mentioned in commit 54fe280bde4093a81ab8a490a6e1d4a3a9403c7f

In GitLab by @damip

changed the description

In GitLab by @damip

changed the description

In GitLab by @AureliaDolo

mentioned in merge request !155

massalabs / massa

minimal API #95

Framework