Skip to content

Commit

Permalink
Remove the scary warning, it's causing too many people to not use cat…
Browse files Browse the repository at this point in the history
…chup
  • Loading branch information
nullun committed Nov 30, 2024
1 parent d3e6189 commit 61cb507
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/run-a-node/setup/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ Genesis hash: SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=

# Sync Node Network using Fast Catchup

Fast Catchup is a new feature and will rapidly update a node using catchpoint snapshots. A new command on goal node is now available for catchup. The entire process should sync a node in minutes rather than hours or days. As an example, the results for a BetaNet fast catchup, at the time of writing this, was a couple minutes to get to the sync point and a few more minutes to sync the remaining blocks since the snapshot. The total blocks synced was around 4.2 million blocks and it finished syncing in under 6 minutes. Actual sync times may vary depending on the number of accounts, number of blocks and the network. Here are the links to get the most recent catchup point snapshot per network. The results include a round to catchup to and the provided catchpoint. Paste into the `goal node catchup` command.
Fast Catchup is a feature and will rapidly update a node using catchpoint snapshots. The entire process should sync a node in minutes/hours rather than days or weeks. As an example, the results for a Mainnet fast catchup, at the time of writing this, was a approximately 60 minutes to get to the sync point and a few more minutes to sync the remaining blocks since the snapshot. The total blocks synced was around 45 million blocks and it finished syncing in under 90 minutes. Actual sync times may vary depending on the number of accounts, number of blocks and the network. Here are the links to get the most recent catchup point snapshot per network. The results include a round to catchup to and the provided catchpoint. Paste into the `goal node catchup` command.

BetaNet
https://algorand-catchpoints.s3.us-east-2.amazonaws.com/channel/betanet/latest.catchpoint
Expand All @@ -498,13 +498,10 @@ MainNet
https://algorand-catchpoints.s3.us-east-2.amazonaws.com/channel/mainnet/latest.catchpoint

The results will look similar to this:
`4420000#Q7T2RRTDIRTYESIXKAAFJYFQWG4A3WRA3JIUZVCJ3F4AQ2G2HZRA`
`44850000#AGPHGZ4YJKIFMF3GXRZMPCWFKRX2CYZUXCN2DAGDONV3UVST46UQ`

!!! warning
Do **NOT** use fast catchup on an *archival* or relay node. If you ever do it, you need to reset your node and start from scratch.

!!! warning
Fast catchup requires trust in the entity providing the catchpoint. An attacker controlling enough relays and proposing a malicious catchpoint can in theory allow a node to sync to an incorrect state of the blockchain. For full decentralization and no trust requirement, either use a catchpoint generated by one of your archival node (you can read the catchpoint using `goal node status`) or catch up from scratch without fast catchup.
Do **NOT** use fast catchup on an *archival* or non-light relay node. If you do, you will need to reset your node and start from scratch.

Steps:

Expand Down Expand Up @@ -532,6 +529,10 @@ Genesis hash: mFgazF+2uRS1tMiL9dsj01hJGySEmPN28B/TjjvpVW0=

`goal node catchup 4420000#Q7T2RRTDIRTYESIXKAAFJYFQWG4A3WRA3JIUZVCJ3F4AQ2G2HZRA`

or let the node retrieve the latest catchpoint itself using

`goal node catchup --force`

3) Run another status and results should look something like this showing a Catchpoint status:
`goal node status`

Expand Down

0 comments on commit 61cb507

Please sign in to comment.