NebulousLabs / Sia

Blockchain-based marketplace for file storage. Project has moved to GitLab: https://gitlab.com/NebulousLabs/Sia
https://sia.tech
MIT License
2.71k stars 441 forks source link

API request: Document the /explorer endpoints #2793

Open mtlynch opened 6 years ago

mtlynch commented 6 years ago

The explorer module is still part of Sia, but its API is undocumented. Are its endpoints part of the supported Sia 1.0 API?

If so, it would be great to have documentation for the API in the API docs. If not, we should make it explicit that the API is unsupported and developers cannot rely on it.

tbenz9 commented 6 years ago

Just as an FYI, I believe the Explorer was rewritten by Luxor. It hasn't been merged in yet but is being tracked here: https://github.com/NebulousLabs/Sia/pull/2458

@nitronick600

bitrocks commented 6 years ago

When would the /explorer /explorer/blocks/:height /explorer/blocks/:hash refactor version be avaliable?
Would it be ok to use it currently to sync blockchain now for my SC wallet?

DavidVorick commented 6 years ago

The explorer is still considered unstable. I think re-writing it to be stable would require an experienced core dev taking 6-12 weeks. We don't want to guarantee correctness nor compatibility as we move forward. At some point we will take the time to re-write the explorer, but given the amount of effort required, it's not very high on our list.