Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

soroban-rpc: review endpoints #4716

Closed
tsachiherman opened this issue Dec 19, 2022 · 7 comments
Closed

soroban-rpc: review endpoints #4716

tsachiherman opened this issue Dec 19, 2022 · 7 comments
Assignees

Comments

@tsachiherman
Copy link
Contributor

Review current Soroban API, identify higher level non-network functionality that could be moved to JS SDK. Remove those endpoints. (needs a new ticket to cover effort)

@tsachiherman tsachiherman moved this to Backlog in Platform Scrum Dec 19, 2022
@tsachiherman tsachiherman moved this from Backlog to Next Sprint Proposal in Platform Scrum Dec 19, 2022
@mollykarcher
Copy link
Contributor

Expected outcome of this would be a document detailing which endpoints we are removing and/or moving, as well as dependent issues for moving each of those individual endpoints.

@mollykarcher mollykarcher moved this from Next Sprint Proposal to Current Sprint in Platform Scrum Jan 5, 2023
@paulbellamy paulbellamy moved this from Current Sprint to In Progress in Platform Scrum Jan 25, 2023
@paulbellamy
Copy link
Contributor

paulbellamy commented Jan 27, 2023

First proposal was here, but moved to stellar-deprecated/soroban-docs#289 for better review & discussion

@paulbellamy paulbellamy moved this from In Progress to Needs Review in Platform Scrum Jan 27, 2023
@tsachiherman
Copy link
Contributor Author

by writing getLedgers you meant "retrieve the txclosemeta for a series of ledgers", right ?
I think that I'd like to be avoid going that path, unless you can see any concrete use for that.
i.e. I'd like to avoid exposing internal data structures as part of our API.

@tsachiherman
Copy link
Contributor Author

The getNetwork seems to be beyond network passphrase. maybe we should rename it into getStatus and retrieve bunch of more info ? i.e. rpc version, captive core version, xdr version, etc.
thinking about that further - maybe two endpoints : one to retrieve "static" info, like versions and network passphrase and one for dynamic status such as last ledger num, early ledger num, etc.

@tsachiherman
Copy link
Contributor Author

tsachiherman commented Jan 27, 2023

could you elaborate on the eta ? is that like a deadline ?

@paulbellamy
Copy link
Contributor

getLedgers, I don't have a specific use case. But seemed in the spirit of a lower-level-but-more-powerful API. I don't think txclosemeta is a very internal data structure. It's in the stellar-xdr library, so anyone can parse it. That said, I'm not particularly attached to the getLedgers endpoint proposal.

@jcx120
Copy link

jcx120 commented Jan 31, 2023

Open: Do we want to include getLedgers?

@paulbellamy paulbellamy moved this from Needs Review to Done in Platform Scrum Feb 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants