-
The
stacks-node
has it's own minimal set of http endpoints referred to asRPC endpoints
- See: https://github.com/blockstack/stacks-blockchain/blob/master/docs/rpc-endpoints.md
- Some common ones:
POST /v2/transactions
- broadcast a tx.GET /v2/pox
- get current PoX-relevant information.GET /v2/accounts/<address>
- used to get the currentnonce
required for creating transactions.
- Some common ones:
- The
stacks-blockchain-api
allows clients to access these endpoints by proxying them through to a load-balanced pool ofstacks-nodes
.
- See: https://github.com/blockstack/stacks-blockchain/blob/master/docs/rpc-endpoints.md
-
The endpoints implemented by
stacks-blockchain-api
provide data that thestacks-node
can't due to various constraints.- Typically this is either data that the
stacks-node
doesn't persist, or data that it cannot efficiently serve to many clients. For example, thestacks-node
can return the current STX balance of an account, but it can't return a history of account transactions. - The API also implements the Rosetta spec created by Coinbase -- "an open standard designed to simplify blockchain deployment and interaction."
- The API also implements the BNS (Blockchain Naming System) endpoints.
- See
/src/api/routes
for the Express.js routes.
- Typically this is either data that the
-
The API creates an "event observer" http server which listens for events from a
stacks-node
"event emitter"- These events are http POST requests that contain things like blocks, transactions, byproducts of executed transactions.
- Transaction "byproducts" are things like asset transfers, smart-contract log data, execution cost data.
- The API processes and stores these as relational data in postgres.
- See
/src/event-stream
for the "event observer" code.
- These events are http POST requests that contain things like blocks, transactions, byproducts of executed transactions.
-
All http endpoints and responses are defined in OpenAPI and JSON Schema.
- See
/docs/openapi.yaml
- These are used to auto generate the docs at https://hirosystems.github.io/stacks-blockchain-api/
- The JSON Schemas are converted into Typescript interfaces, which are used internally by the db controller module to transform SQL query results into the correct object shapes.
- ALSO the OpenAPI + JSONSchemas are used to generate a standalone
@stacks/blockchain-api-client
.
- See
-
The easiest/quickest way to develop in this repo is using the vscode debugger. It uses docker-compose to setup a
stacks-node
and postgres instance.- Alternatively, you can run
npm run dev:integrated
which does the same thing but without a debugger.
- Alternatively, you can run