https://github.com/stacks-network/stacks-blockchain-docker

Stacks-blockchain with API using docker compose
https://github.com/stacks-network/stacks-blockchain-docker

api bitcoin blockchain decentralized dns docker hiro stacks

Last synced: 3 months ago
JSON representation

Stacks-blockchain with API using docker compose

• Host: GitHub
• URL: https://github.com/stacks-network/stacks-blockchain-docker
• Owner: stacks-network
• License: gpl-3.0
• Created: 2020-10-20T20:42:59.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-29T17:11:19.000Z (8 months ago)
• Last Synced: 2024-04-14T11:50:54.593Z (7 months ago)
• Topics: api, bitcoin, blockchain, decentralized, dns, docker, hiro, stacks
• Language: Shell
• Homepage:
• Size: 644 KB
• Stars: 25
• Watchers: 16
• Forks: 31
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Stacks Blockchain with Docker

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

Run your own Stacks Blockchain node easily with just few commands.

⚠️ **[docker-compose version `2.2.2` or greater is required](./docs/docker.md)**

---

## Quickstart

```bash

git clone https://github.com/stacks-network/stacks-blockchain-docker && cd stacks-blockchain-docker

cp sample.env .env

```

### Sync from genesis

```bash

./manage.sh -n mainnet -a start

```

### Seed chainstate from Hiro Archiver

Using data from the [Hiro Archiver](https://docs.hiro.so/hiro-archive) service, this script will download the latest files, extract them and restore the postgres data. \

_**Note**: it can take a long time to process the data, and you'll need at a minimum roughly 150GB of free space_

```bash

sudo ./scripts/seed-chainstate.sh

./manage.sh -n mainnet -a start

```

- [Requirements](./docs/requirements.md)

- [Docker Setup](./docs/docker.md)

- [Configuration](./docs/config.md)

- [Upgrading](./docs/upgrade.md)

- [Usage](./docs/usage.md)

- [Common Issues](./docs/issues.md)

---

## Accessing the services

_For networks other than `mocknet`, downloading the initial headers can take several minutes. \

Until the headers are downloaded, the `/v2/info` endpoints won't return any data. \

Use the command `./manage.sh -n  -a logs` to check the sync progress._

**stacks-blockchain**:

```bash

curl -sL localhost:20443/v2/info | jq

```

**stacks-blockchain-api**:

```bash

curl -sL localhost:3999/v2/info | jq

```

**proxy** _(optional argument)_:

```bash

curl -sL localhost/v2/info | jq

curl -sL localhost/ | jq

```