Skip to content

docs/node: Update state sync config to be compatible with Oasis Core v25.1 #1211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anzoman merged 2 commits into from
Apr 14, 2025
Merged

docs/node: Update state sync config to be compatible with Oasis Core v25.1 #1211

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c12f5c
docs/node: Make state sync config compatible with Oasis Core v25.1
anzoman Apr 13, 2025
d1405de
docs/node: Replace Tendermint with CometBFT links for state sync page
anzoman Apr 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/node/run-your-node/advanced/sync-node-using-state-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The State Sync is a way to **quickly bootstrap** a **full Oasis node** (either a
[validator node](../validator-node.mdx) or a
[non-validator node](../non-validator-node.mdx)) by using the
[Tendermint's Light Client protocol]. It allows one to initialize a node from a
[CometBFT's Light Client protocol]. It allows one to initialize a node from a
trusted height, its corresponding block's header and a trusted validator set
(given in the [genesis document](../../genesis-doc.md)). It does so by securely
updating the node's trusted state by requesting and verifying a minimal set of
Expand All @@ -19,7 +19,7 @@ node to the other].

:::caution

Tendermint's Light Client protocol requires at least 1 full node to be correct
CometBFT's Light Client protocol requires at least 1 full node to be correct
to be able to [detect and submit evidence for a light client attack].

:::
Expand All @@ -38,8 +38,11 @@ consensus:
# Enable consensus state sync (i.e. CometBFT light client sync).
state_sync:
enabled: true
trust_height: {{ trusted_height }}
trust_hash: "{{ trusted_height_hash }}"
# Configure trusted height & hash for the light client.
light_client:
trust:
height: {{ trusted_height }}
hash: "{{ trusted_height_hash }}"

... trimmed ...

Expand All @@ -66,11 +69,11 @@ something like the following in your node's logs:

:::

[Tendermint's Light Client protocol]:
https://docs.tendermint.com/main/tendermint-core/light-client.html
[CometBFT's Light Client protocol]:
https://docs.cometbft.com/main/explanation/core/light-client
[copy state from one node to the other]: copy-state-from-one-node-to-the-other.md
[detect and submit evidence for a light client attack]:
https://docs.tendermint.com/main/tendermint-core/light-client.html#where-to-obtain-trusted-height-hash
https://docs.cometbft.com/main/explanation/core/light-client#where-to-obtain-trusted-height--hash
[Wiping Node State]: ../maintenance/wiping-node-state.md#state-wipe-and-keep-node-identity

### Obtaining Trusted Height and Hash
Expand Down