Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
archiver_pk="..."
backfill_pk="..."
backfill_start_block="0"
network="./networks/your_network.json"

DATABASE_HOST=""
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ While a WeaveVM Archiver node can run without web2 component dependencies, this
```js
archiver_pk="" // WeaveVM archiver PK
backfill_pk="" // WeaveVM backfill PK
backfill_start_block="0" // it defaults to 0 (genesis), but it's dynamic, so you can specify from which block number you want to start backfilling
network="./networks/your_network.json"

DATABASE_HOST="" // planetscale
Expand All @@ -52,6 +53,15 @@ To start archiving your network block data on WeaveVM:
6. set `start_block` value to the most recent network's blockheight. That will facilitate the archiver to start in sync with live blockheight while, in parallel, reindexing from genesis using the `backfill_address`.
7. Set up your PlanetScale DB according to `db_schema.sql`.

#### Parallel Threads of Archiving

As mentioned previously, `archiver_address` is responsible for archiving blocks starting from the `start_block` specified in your `network.json` config file, while also keeping up with the network’s current blockheight (live sync). Meanwhile, `backfill_address` handles archiving blocks from `backfill_start_block` up to `start_block`.

```txt
backfill thread: backfill_start_block -> start_block
live sync thread: start_block -> network's live blockheight
```

### RPC Proxy and Caching

You can use [eRPC](https://github.com/erpc/erpc) to cache, load-balance and failover between as many RPC endpoints and use eRPC's proxy URL in each network's config for WeaveVM. This will increase performance and resiliency and reduce RPC usage cost while fetching network's block data via WeaveVM.
Expand Down
4 changes: 3 additions & 1 deletion src/utils/backfill_genesis.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
use crate::utils::archive_block::archive;
use crate::utils::planetscale::ps_archive_block;
use crate::utils::schema::Network;
use crate::utils::env_var::get_env_var;
use anyhow::{Error, Ok};

pub async fn backfill_from_genesis() -> Result<(), Error> {
let network = Network::config();
let config_start_block = network.start_block;
let backfill_blocks: Vec<u64> = (0..=config_start_block).collect();
let backfill_block_start: String = get_env_var("backfill_start_block").unwrap_or(0.to_string());
let backfill_blocks: Vec<u64> = (backfill_block_start.parse::<u64>().unwrap()..=config_start_block).collect();

if config_start_block == 0 {
return Ok(());
Expand Down