mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-04-30 22:02:35 +08:00
Updated config.toml location in the how to run API node doc
This commit is contained in:
Lavanya Kasturi
@@ -57,7 +57,7 @@ Egress:
|
||||
- `8333`
|
||||
- `20443-20444`
|
||||
|
||||
These egress ports are for syncing [`stacks-blockchain`][] and Bitcoin headers. If they're not open, the sync will fail.
|
||||
These egress ports are for syncing `stacks-blockchain-api` and Bitcoin headers. If they're not open, the sync will fail.
|
||||
|
||||
## Step 1: Initial setup
|
||||
|
||||
@@ -153,9 +153,20 @@ docker ps --filter name=stacks-blockchain-api
|
||||
|
||||
## Step 4: Running Stacks blockchain
|
||||
|
||||
In order for the API to be functional, the [`stacks-blockchain-api`][] container must have data from a running
|
||||
[`stacks-blockchain`][] instance. First create the `./config/Config.toml` file and add the following content to the
|
||||
file using a text editor:
|
||||
A usable API instance needs to have data from a running [stacks-blockchain](https://github.com/stacks-network/stacks-blockchain) instance.
|
||||
|
||||
Because we're focusing on running the API with Docker, it also makes things easier if we run the stacks-blockchain instance similarly.
|
||||
|
||||
With that in mind, you will need to have the following in your Config.toml - this config block will send blockchain events to the API instance that was started earlier:
|
||||
|
||||
```toml
|
||||
[[events_observer]]
|
||||
endpoint = "<fqdn>:3700"
|
||||
retry_count = 255
|
||||
events_keys = ["*"]
|
||||
```
|
||||
|
||||
Here is an example `Config.toml` that you can use. Create this file as ./config/Config.toml:
|
||||
|
||||
```toml
|
||||
[node]
|
||||
@@ -190,7 +201,7 @@ read_only_call_limit_runtime = 1000000000
|
||||
The `[[events_observer]]` block configures the instance to send blockchain events to the API container that you
|
||||
started previously.
|
||||
|
||||
Start the [`stacks-blockchain`][] container with the following command:
|
||||
Start the `stacks-blockchain` container with the following command:
|
||||
|
||||
```sh
|
||||
docker run -d --rm \
|
||||
@@ -204,10 +215,12 @@ docker run -d --rm \
|
||||
/bin/stacks-node start --config /src/stacks-node/Config.toml
|
||||
```
|
||||
|
||||
You can verify the running [`stacks-blockchain`][] container with the command:
|
||||
You can verify the stacks-blockchain instance running on the ports 20443-20444:
|
||||
|
||||
```sh
|
||||
docker ps --filter name=stacks-blockchain
|
||||
$ docker ps --filter name=stacks-blockchain$
|
||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||
199e37a324f1 blockstack/stacks-blockchain "/bin/stacks-node st…" 1 minute ago Up 1 minute 0.0.0.0:20443-20444->20443-20444/tcp, :::20443-20444->20443-20444/tcp stacks-blockchain
|
||||
```
|
||||
|
||||
## Step 5: Verifying the services
|
||||
@@ -221,7 +234,7 @@ To verify the database is ready:
|
||||
2. List current databases with the command `\l`
|
||||
3. Disconnect from the database with the command `\q`
|
||||
|
||||
To verify the [`stacks-blockchain`][] tip height is progressing use the following command:
|
||||
To verify the `stacks-blockchain` tip height is progressing use the following command:
|
||||
|
||||
```sh
|
||||
curl -sL localhost:20443/v2/info | jq
|
||||
@@ -249,7 +262,7 @@ If the instance is running you should receive terminal output similar to the fol
|
||||
}
|
||||
```
|
||||
|
||||
Verify the [`stacks-blockchain-api`][] is receiving data from the [`stacks-blockchain`][] with the following command:
|
||||
Verify the `stacks-blockchain-api` is receiving data from the `stacks-blockchain-api` with the following command:
|
||||
|
||||
```sh
|
||||
curl -sL localhost:3999/v2/info | jq
|
||||
|
||||
@@ -41,7 +41,7 @@ Egress:
|
||||
- `8333`
|
||||
- `20443-20444`
|
||||
|
||||
These egress ports are for syncing [`stacks-blockchain`][] and Bitcoin headers. If they're not open, the sync will fail.
|
||||
These egress ports are for syncing `stacks-blockchain-api` and Bitcoin headers. If they're not open, the sync will fail.
|
||||
|
||||
## Step 1: Initial setup
|
||||
|
||||
@@ -88,7 +88,7 @@ read_only_call_limit_read_count = 30
|
||||
read_only_call_limit_runtime = 1000000000
|
||||
```
|
||||
|
||||
Start the [`stacks-blockchain`][] container with the following command:
|
||||
Start the `stacks-blockchain-api` container with the following command:
|
||||
|
||||
```sh
|
||||
docker run -d --rm \
|
||||
@@ -101,7 +101,7 @@ docker run -d --rm \
|
||||
/bin/stacks-node start --config /src/stacks-node/Config.toml
|
||||
```
|
||||
|
||||
You can verify the running [`stacks-blockchain`][] container with the command:
|
||||
You can verify the running `stacks-blockchain-api` container with the command:
|
||||
|
||||
```sh
|
||||
docker ps --filter name=stacks-blockchain
|
||||
@@ -115,7 +115,7 @@ The initial header sync can take several minutes, until this is done the followi
|
||||
|
||||
:::
|
||||
|
||||
To verify the [`stacks-blockchain`][] burn chain header sync progress:
|
||||
To verify the `stacks-blockchain-api` burn chain header sync progress:
|
||||
|
||||
```sh
|
||||
docker logs stacks-blockchain
|
||||
@@ -129,7 +129,7 @@ INFO [1626290748.103291] [src/burnchains/bitcoin/spv.rs:926] [main] Syncing Bitc
|
||||
INFO [1626290776.956535] [src/burnchains/bitcoin/spv.rs:926] [main] Syncing Bitcoin headers: 1.7% (12000 out of 691034)
|
||||
```
|
||||
|
||||
To verify the [`stacks-blockchain`][] tip height is progressing use the following command:
|
||||
To verify the `stacks-blockchain-api` tip height is progressing use the following command:
|
||||
|
||||
```sh
|
||||
curl -sL localhost:20443/v2/info | jq
|
||||
|
||||
@@ -41,7 +41,7 @@ Egress:
|
||||
- `18333`
|
||||
- `20443-20444`
|
||||
|
||||
These egress ports are for syncing [`stacks-blockchain`][] and Bitcoin headers. If they're not open, the sync will fail.
|
||||
These egress ports are for syncing `stacks-blockchain-api` and Bitcoin headers. If they're not open, the sync will fail.
|
||||
|
||||
## Step 1: Initial setup
|
||||
|
||||
@@ -60,7 +60,7 @@ mkdir -p ./stacks-node/persistent-data/stacks-blockchain/testnet && cd stacks-no
|
||||
|
||||
## Step 2: Running Stacks blockchain
|
||||
|
||||
Start the [`stacks-blockchain`][] container with the following command:
|
||||
Start the `stacks-blockchain-api` container with the following command:
|
||||
|
||||
```sh
|
||||
docker run -d --rm \
|
||||
@@ -72,7 +72,7 @@ docker run -d --rm \
|
||||
/bin/stacks-node xenon
|
||||
```
|
||||
|
||||
You can verify that the container [`stacks-blockchain`][] is running with the command:
|
||||
You can verify that the container `stacks-blockchain-api` is running with the command:
|
||||
|
||||
```sh
|
||||
docker ps --filter name=stacks-blockchain
|
||||
@@ -86,7 +86,7 @@ The initial header sync can take several minutes, until this is done the followi
|
||||
|
||||
:::
|
||||
|
||||
To verify the [`stacks-blockchain`][] burn chain header sync progress:
|
||||
To verify the `stacks-blockchain-api` burn chain header sync progress:
|
||||
|
||||
```sh
|
||||
docker logs stacks-blockchain
|
||||
@@ -100,7 +100,7 @@ INFO [1626290748.103291] [src/burnchains/bitcoin/spv.rs:926] [main] Syncing Bitc
|
||||
INFO [1626290776.956535] [src/burnchains/bitcoin/spv.rs:926] [main] Syncing Bitcoin headers: 1.7% (12000 out of 2034380)
|
||||
```
|
||||
|
||||
To verify the [`stacks-blockchain`][] tip height is progressing use the following command:
|
||||
To verify the `stacks-blockchain-api` tip height is progressing use the following command:
|
||||
|
||||
```sh
|
||||
curl -sL localhost:20443/v2/info | jq
|
||||
|
||||
Reference in New Issue
Block a user