stacks-network/stacks-core

Add additional GET RPC endpoints

Open

#4,358 opened on Feb 8, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Rust (758 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (3,063 stars)
PR merge metrics
 (PR metrics pending)

Description

Problem: the stacks blockchain RPC interface for GET requests is limited compared the data exposed in bitcoin/etc and the rich data in Hiro's API.

With recent changes to the HTTP interface (https://github.com/stacks-network/stacks-core/tree/master/stackslib/src/net/api), it should be much easier to add more RPC endpoints to expose some generic data. Initially, i'm thinking something like:

  • block data
  • tx data
  • address info

some comparable bitcoin-cli rpc commands: getblockhash getblock getrawtransaction gettxout

for the data exposed, i don't think it should be a requirement to be as detailed as the Hiro API - but i think should be enough to understand what is in a block, or what a tx is doing (as well as retrieving the block hash by a block height).

references: bitcoin RPC:

Hiro API:

Contributor guide

Research direction
Inspect the existing HTTP interface at stackslib/src/net/api and add new GET endpoints for block data, transaction data, and address info, following the pattern of bitcoin RPC commands.
Tech stack
rust
Domain
blockchainbackendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustBlockchain basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60