Skip to content

Commit aca8474

Browse files
committed
docs: address comments
1 parent b9fcff0 commit aca8474

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

Diff for: docs/learn/advanced/18-syncing.md

+34-4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ There are two types of syncing:
1616

1717
## Observing syncing progress
1818

19+
> ### Note: This section applies to comet users.
20+
1921
### Block Sync Metrics
2022

2123
- `blocksync_syncing`: Indicates whether a node is currently block syncing.
@@ -31,6 +33,7 @@ blocksync:
3133
version: "v0"
3234
```
3335

36+
- `version`: The version of the block sync protocol to use.
3437

3538
### State Sync Metrics
3639

@@ -51,12 +54,39 @@ statesync:
5154
chunk_fetchers: "4"
5255
```
5356

54-
### Checking if sync is complete
57+
- `enable`: Set to true to enable state sync.
58+
- `rpc_servers`: Comma-separated list of RPC servers for state sync.
59+
- `trust_height`: Block height to trust for state sync.
60+
- `trust_hash`: Block hash to trust for state sync.
61+
- `trust_period`: Trust period for light client verification.
62+
- `discovery_time`: Time to spend discovering snapshots before picking one.
63+
- `temp_dir`: Directory for temporary state sync files.
64+
- `chunk_request_timeout`: Timeout for chunk requests.
65+
- `chunk_fetchers`: Number of concurrent chunk fetchers.
5566

56-
- Query for the node status using the REST or GRPC API
57-
- Check the `SyncInfo.CatchingUp` field
58-
- If the field is `false`, then syncing is complete
67+
### Checking if sync is complete
5968

69+
Query for the node status using the REST or GRPC API:
70+
71+
REST example:
72+
```bash
73+
curl http://localhost:1317/cosmos/base/tendermint/v1beta1/syncing
74+
```
75+
76+
Expected response:
77+
```json
78+
{
79+
"syncing": false
80+
}
81+
```
82+
83+
GRPC example:
84+
```bash
85+
grpcurl -plaintext localhost:9090 cosmos.base.tendermint.v1beta1.Service/GetSyncing
86+
```
87+
88+
The response includes `SyncInfo.CatchingUp` field
89+
Syncing is complete when this field is `false`
6090

6191

6292

0 commit comments

Comments
 (0)