kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-01-12 16:53:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: small update to overview.md

Browse Source
This commit is contained in:
Matthew Little
2022-06-14 15:48:40 +02:00
committed by GitHub
parent 4c6f2a2da4
commit b42475e558
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
overview.md
View File

@@ -1,12 +1,13 @@
![API architecture!](api-architecture.png)
* The `stacks-node` has it's own minimal set of http endpoints referred to as `RPC 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 current `nonce` required for creating transactions.
* The `stacks-blockchain-api` allows clients to access these endpoints by proxying them through to a load-balanced pool of `stacks-nodes`.
* 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.
* `POST /v2/contracts/call-read/<contract>/<function>` - evaluates and returns the result of calling a Clarity function.
* `POST /v2/fees/transaction` - evaluates a given transaction and returns tx fee estimation data.
* `GET /v2/accounts/<address>` - used to get the current `nonce` required for creating transactions.
* The endpoints implemented by `stacks-blockchain-api` provide data that the `stacks-node` can't due to various constraints.