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

feat/rpc endpoints #783

Merged
merged 12 commits into from
Oct 11, 2024
Merged

feat/rpc endpoints #783

merged 12 commits into from
Oct 11, 2024

Conversation

ryanwaits
Copy link
Collaborator

@ryanwaits ryanwaits commented Oct 2, 2024

What does this PR do?

Adds a new API Reference section for Stacks core RPC endpoints, making a clear distinction between the Stacks Blockchain API.

Ref: #782

  • Remove duplicate v2 endpoints inside of Stacks BlockchainAPI
  • Add new Core RPC section

Copy link

vercel bot commented Oct 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 0:53am

@ryanwaits ryanwaits changed the title Feat/rpc endpoints feat/rpc endpoints Oct 2, 2024
There was copy/pasta from Hiro's Stacks API overview page. I replaced the description with something specific to the RPC.

I'm not sure if this is accurate / how we should position this against Hiro's API, so take a look and let me know what you think.
Swapped the name of the "Stacks Core RPC API" to "Stacks Node RPC API"

Also updated some copy.
@max-crawford
Copy link
Contributor

The copy on the overview page looks good, but we need to update the side bar to read "Stacks Node RPC" instead of "Stacks Core RPC" and I'm not sure where that lives. @ryanwaits

Further, is it worth elaborating on this overview page when a developer would want to use the RPC API instead of Hiro's Stacks API? I'm inclined to say no - and that we want to point users to Hiro's Stacks API - but I want to flag that one omission from this overview page in its current form is when a user should use this API instead of ours.

@ryanwaits
Copy link
Collaborator Author

is it worth elaborating on this overview page when a developer would want to use the RPC API instead of Hiro's Stacks API?

i dont think so. a better way to handle this would be referencing the right endpoints throughout docs in a contextual manner. like if we are talking about broadcasting a tx with stacks.js, we could also reference how to do it via rpc node api, etc

Copy link
Contributor

@ECBSJ ECBSJ left a comment

Choose a reason for hiding this comment

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

lgtm

@ryanwaits ryanwaits merged commit 182a160 into main Oct 11, 2024
4 checks passed
@ryanwaits ryanwaits deleted the feat/rpc-endpoints branch October 11, 2024 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants