Skip to content

Commit

Permalink
update sync page for Story Protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
redwest88 committed Sep 11, 2024
1 parent 66bfdfc commit 3c189d8
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/story-protocol/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Story",
"label": "Story Protocol",
"position": 17
}
4 changes: 4 additions & 0 deletions docs/story-protocol/sync/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Sync",
"position": 2
}
29 changes: 29 additions & 0 deletions docs/story-protocol/sync/addrbook.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 4
description: AddrBook
---

# AddrBook

> Address book refers to a local database or record that a node maintains of all the peers it has come into contact with or learned about. This helps in the peer discovery process.
import SelectPaste from '@site/src/components/SelectPaste';

import { addrBook } from '@site/src/components/SelectPaste/addrBook.ts';

export let endpoints = [
'https://server-5.itrocket.net/testnet/story/addrbook.json',
'https://snapshots.kjnodes.com/story-testnet/addrbook.json',
'https://snapshots.lavenderfive.com/testnet-addrbooks/story/addrbook.json',
'https://share102.utsa.tech/story/addrbook.json',
'https://raw.githubusercontent.com/McDaan/general/main/story/addrbook.json',
'https://ss-t.story.nodestake.org/addrbook.json',
'https://snapshots.polkachu.com/testnet-addrbook/story/addrbook.json',
'https://support.synergynodes.com/addrbook/story_testnet/addrbook.json',
];

export let home = 'story/story';

export let binary = 'story';

<SelectPaste endpoints={endpoints} codeTemplate={addrBook} home={home} binary={binary} tip="Click on any endpoint to paste it into the code block." />
20 changes: 20 additions & 0 deletions docs/story-protocol/sync/peers-seeds.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_position: 3
description: Live Peers / Seeds
---

# Live Peers / Seeds

> When you start a node, you often need to connect to the network. This requires you to connect to one or more peers to start downloading the blockchain and receiving new blocks and transactions. Seeding nodes or bootstrap nodes help in this initial connection process.
:::info
Copy and run the commands below to add your peers into `config.toml`.
:::

import LivePeers from '@site/src/components/LivePeers';

export let home = 'story/story';

export let binary = 'story';

<LivePeers rpc="https://story-testnet-rpc.f5nodes.com" home={home} binary={binary} />
57 changes: 57 additions & 0 deletions docs/story-protocol/sync/snapshot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
sidebar_position: 1
description: Snapshot
---

# Snapshot

> When a new node joins a network, it can use a snapshot — a compressed backup of the chain's data — to quickly synchronize with the current state. Snapshots expedite the process, reducing the need to download and verify every transaction from the beginning.
import Snapshots from '@site/src/components/Snapshots';

<Snapshots tip="Click on any snapshot to paste it into the code block. We provide snapshots for both the execution and consensus layers." endpoint="https://story-testnet-snapshots.f5nodes.com/"/>

:::info
Snapshots are taken every <i>2 hours</i>.
:::


```bash
sudo systemctl stop story && sudo systemctl stop story-geth

# make a backup of the validator state
cp $HOME/.story/story/data/priv_validator_state.json $HOME/.story/priv_validator_state.json.backup

# delete data folders
rm -rf $HOME/.story/story/data
rm -rf $HOME/.story/geth/iliad/geth/chaindata

# download and decompress snapshots
story_snapshot_url=$(curl -sL 'https://story-testnet-snapshots.f5nodes.com' | grep -Eo '>iliad-0_story.*\.tar\.lz4' | sed 's/^>//' | head -n1)
geth_snapshot_url=$(curl -sL 'https://story-testnet-snapshots.f5nodes.com' | grep -Eo '>iliad-0_geth.*\.tar\.lz4' | sed 's/^>//' | head -n1)

wget "https://story-testnet-snapshots.f5nodes.com/${story_snapshot_url}" -O - | lz4 -dc - | tar -xf - -C $HOME/.story
wget "https://story-testnet-snapshots.f5nodes.com/${geth_snapshot_url}" -O - | lz4 -dc - | tar -xf - -C $HOME/.story/geth/iliad/geth


# replace the priv_validator_state.json you have backed up
cp $HOME/.story/priv_validator_state.json.backup $HOME/.story/story/data/priv_validator_state.json

# restart your services
sudo systemctl restart story && sudo systemctl restart story-geth
```

You can also use snapshots from other providers:

#### kjnodes:
```bash
https://snapshots.kjnodes.com/story-testnet/snapshot_latest.tar.lz4 # story snapshot
https://snapshots.kjnodes.com/story-testnet/snapshot_latest_geth.tar.lz4 # geth snapshot
```

#### Mandragora:
```bash
https://snapshots.mandragora.io/story_snapshot.lz4 # story snapshot
https://snapshots.mandragora.io/geth_snapshot.lz4 # geth snapshot
```

0 comments on commit 3c189d8

Please sign in to comment.