balq 0.3.0

BAL query: local archive of contract storage history, verified against block headers.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

use super::Ctx;
use crate::util::emit;
use alloy_primitives::Address;
use anyhow::Result;
use bal_source::{BalSource, JsonRpcSource};
use serde_json::json;

/// `from` defaults to the node's head + 1: "from now on".
pub async fn watch(
    ctx: &Ctx,
    address: Address,
    from: Option<u64>,
    rpc: Option<String>,
) -> Result<()> {
    let from = match from {
        Some(f) => f,
        None => {
            let rpc = ctx.cfg.rpc(rpc)?;
            JsonRpcSource::new(&rpc).head().await? + 1
        }
    };
    ctx.open_local()?.watch(address, from)?;
    if ctx.json {
        emit(&json!({ "watching": address, "from": from }));
    } else {
        println!("watching {address} from block {from}");
        println!(
            "next: `balq sync --follow`; for history before {from}: `balq backfill {address}`"
        );
    }
    Ok(())
}

pub fn unwatch(ctx: &Ctx, address: Address) -> Result<()> {
    ctx.open_local()?.unwatch(address)?;
    if ctx.json {
        emit(&json!({ "unwatched": address }));
    } else {
        println!("unwatched {address}, data removed");
    }
    Ok(())
}

pub fn status(ctx: &Ctx) -> Result<()> {
    let ar = ctx.open()?;
    let s = ar.stats()?;
    let created_at = |a: &Address| s.created.iter().find(|(c, _)| c == a).map(|(_, b)| *b);
    if ctx.json {
        let mut out = crate::util::stats_json(&s);
        out["data"] = json!(ctx.data);
        out["via"] = json!(ar.via());
        emit(&out);
        return Ok(());
    }
    match ar.via() {
        Some(url) => println!("data:     {}  (read via {url})", ctx.data.display()),
        None => println!("data:     {}", ctx.data.display()),
    }
    match s.head {
        Some((n, h)) => println!("head:     {n} ({h})"),
        None => println!("head:     (nothing synced yet)"),
    }
    println!("watch:    {} address(es)", s.watches.len());
    for (a, f) in &s.watches {
        match created_at(a) {
            Some(c) => println!("  {a}  from {f}  (created at {c}: history complete)"),
            None => println!("  {a}  from {f}"),
        }
    }
    println!("records:  {} slot record(s)", s.slot_records);
    let unknown = s.slots_pending + s.slots_lost;
    if unknown > 0 {
        println!(
            "unknown:  {unknown} slot(s) have no value before their first recorded write — `balq backfill <address> --resolve`"
        );
    } else {
        println!("unknown:  none — every recorded slot has a known earlier value");
    }
    if s.slots_done > 0 {
        println!(
            "settled:  {} slot(s) with a known earlier value",
            s.slots_done
        );
    }
    println!(
        "headers:  {} retained for reorg detection",
        s.retained_headers
    );
    println!("file:     {:.1} MB", s.file_bytes as f64 / 1e6);
    Ok(())
}