https://github.com/hirosystems/stacks-blockchain-api

API for the Stacks blockchain
https://github.com/hirosystems/stacks-blockchain-api

api blockchain blockstack hacktoberfest stacks

Last synced: about 2 months ago
JSON representation

API for the Stacks blockchain

• Host: GitHub
• URL: https://github.com/hirosystems/stacks-blockchain-api
• Owner: hirosystems
• License: gpl-3.0
• Created: 2020-02-06T15:26:09.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2025-04-02T16:17:46.000Z (3 months ago)
• Last Synced: 2025-04-06T00:27:48.705Z (3 months ago)
• Topics: api, blockchain, blockstack, hacktoberfest, stacks
• Language: TypeScript
• Homepage: https://stacks-blockchain-api.vercel.app
• Size: 73.6 MB
• Stars: 179
• Watchers: 29
• Forks: 122
• Open Issues: 124
• Metadata Files:
  • Readme: README-rosetta.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Testing the Rosetta APIs

Build and run the `rosetta.Dockerfile` image:

    docker build -t rosetta:stable -f rosetta.Dockerfile .

    docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \

        --name rosetta rosetta:stable

By default, this will connect to the testnet.  To run a local node, run

    docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \

        --name rosetta -e STACKS_NETWORK=mocknet rosetta:stable

Optionally, you can seed the chainstate for testnet/mainnet using [Hiro archive data](https://docs.hiro.so/references/hiro-archive#what-is-the-hiro-archive):

    docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \

            --name rosetta -e SEED_CHAINSTATE=true rosetta:stable

Use a recent version of [rosetta-cli](https://github.com/coinbase/rosetta-cli) to test the endpoints:

    rosetta-cli --configuration-file rosetta-cli-config/rosetta-config.json \

        view:block 1

    rosetta-cli --configuration-file rosetta-cli-config/rosetta-config.json \

        check:data

`rosetta-cli` will sync with the blockchain until it reaches the tip,

and then exit, displaying the test results.

At present, account reconciliation is disabled; proper testing of that

requires token transfer transactions while `rosetta-cli` is running.

Documentation for the Rosetta APIs can be found at

https://hirosystems.github.io/stacks-blockchain-api/