varro 0.1.0-alpha

A persistent, robust, and composable proposal service for rollup stacks.
Documentation 
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

use thiserror::Error;

/// [crate::client::Varro] Error
#[derive(Debug, Error)]
pub enum VarroError {
    /// Missing client
    #[error("missing client")]
    MissingClient,
}

/// A [crate::rollup::RollupNode] Error
#[derive(Debug, Error)]
pub enum RollupNodeError {
    /// Failed to create a new rollup node
    /// from the given rpc url.
    #[error("failed to create a new rollup node from the given rpc url: {0}")]
    RollupNodeInvalidUrl(String),
}

/// A [crate::config::Config] Error
#[derive(Debug, Error)]
pub enum ConfigError {
    /// L1 Client URL is invalid
    #[error("l1 client url is invalid")]
    InvalidL1ClientUrl,
    /// Rollup Node RPC URL is invalid
    #[error("rollup node rpc url is invalid")]
    InvalidRollupNodeRpcUrl,
    /// Failed to create toml file on disk
    #[error("failed to create toml file at {0}")]
    TomlFileCreation(String),
    /// Failed to translate the [crate::config::Config] to a toml object
    #[error("failed to translate the config to a toml object")]
    ConfigTomlConversion,
    /// Failed to write the [crate::config::Config] to the toml file
    #[error("failed to write the config to the toml file")]
    TomlFileWrite,
    /// An invalid output oracle address was provided
    #[error("an invalid output oracle address was provided: {0}")]
    InvalidOutputOracleAddress(String),
    /// Failed to parse the given output private key as a 32 byte hex string.
    #[error("failed to parse the given output private key as a 32 byte hex string: {0}")]
    InvalidOutputPrivateKey(String),
}

/// A [crate::client::VarroBuilder] Error
#[derive(Debug, Error)]
pub enum VarroBuilderError {
    /// An [crate::L1Client] is required to build a [Varro] client.
    #[error("an l1 client is required to build a varro client")]
    MissingL1Client,
    /// A [crate::rollup::RollupNode] is required to build a [Varro] client.
    #[error("an rollup node is required to build a varro client")]
    MissingRollupNode,
    /// An [crate::output::OutputOracle] is required to build a [Varro] client.
    #[error("an output oracle is required to build a varro client")]
    MissingOutputOracle,
    /// A [crate::proposer::Proposer] is required to build a [Varro] client.
    #[error("a proposer is required to build a varro client")]
    MissingProposer,
    /// An output private key is required to build a [Varro] client.
    #[error("an output private key is required to build a varro client")]
    MissingOutputPrivateKey,
    /// A polling interval is required to build a [Varro] client.
    #[error("a polling interval is required to build a varro client")]
    MissingPollingInterval,
}