flashbots 0.1.0

A Flashbots API client for Rust
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! A Flashbots API client for Rust.
//!
//! ## Structure
//!
//! The crate is segmented by Flashbots components:
//!
//! - [Flashbots Auction](crate::auction)
//! - [Flashbots Protect](crate::protect)
//! - [Flashbots Blocks](crate::blocks)
//!
//! Additionally, a set of helpers for simulating bundles and transactions can be found in the [simulation](crate::simulation) module.
//!
//! ## Examples
//!
//! ### Flashbots Auction
//!
//! ### Flashbots Protect
//!
//! ### Flashbots Blocks
//!
//! ## Ethers Middleware
//!
//! For an [`ethers`](ethers) middleware leveraging this crate, refer to [`ethers-flashbots`](ethers-flashbots).

/// Core types.
pub mod types {
    pub type BlockNumber = ethers_core::types::U64;
}

/// Simulation types and helpers.
pub mod simulation {
    use crate::types::BlockNumber;

    pub struct SimulationParameters {
        state_block_number: BlockNumber,
        timestamp: usize,
    }

    pub enum SimulationError {
        MaxFeePerGasTooLow,
    }
}

/// Flashbots Auction
pub mod auction {
    use crate::types::BlockNumber;
    use ethers_core::types::Bytes;
    use ethers_core::types::TxHash;
    use uuid::Uuid;

    pub struct Bundle {
        transactions: Vec<Bytes>,
        block_number: BlockNumber,
        min_timestamp: Option<usize>,
        max_timestamp: Option<usize>,
        reverting_tx_hashes: Vec<TxHash>,
        replacement_uuid: Option<Uuid>,
    }

    pub struct CachedBundle {
        bundle_id: Uuid,
        transactions: Vec<Bytes>,
    }

    pub mod stats {
        pub struct User {}
        pub struct Bundle {}
    }
}

/// Flashbots Protect
pub mod protect {
    use crate::simulation::SimulationError;
    use crate::types::BlockNumber;
    use ethers_core::types::Transaction;
    use ethers_core::types::TxHash;

    pub struct Preferences {
        fast: bool,
    }

    pub struct PrivateTransaction<T> {
        transaction: T,
        max_block_number: BlockNumber,
        preferences: Preferences,
    }

    pub enum Status {
        Pending,
        Included,
        Failed,
        Cancelled,
        Unknown,
    }

    pub struct TransactionStatus {
        status: Status,
        hash: TxHash,
        max_block_number: BlockNumber,
        transaction: Transaction,
        fast_mode: bool,
        seen_in_mempool: bool,
        simulation_error: SimulationError,
    }
}

/// Flashbots Blocks
pub mod blocks {
    use crate::types::BlockNumber;
    use ethers_core::types::{Address, TxHash, U256};

    pub struct Transaction {
        transaction_hash: TxHash,
        tx_index: U256,
        bundle_index: U256,
        block_number: BlockNumber,
        eoa_address: Address,
        to_address: Address,
        gas_used: U256,
        gas_price: U256,
        fee_recipient_eth_diff: U256,
        eth_sent_to_fee_recipient: U256,
    }

    pub struct Block {
        block_number: BlockNumber,
        fee_recipient: Address,
        fee_recipient_eth_diff: U256,
        eth_sent_to_fee_recipient: U256,
        gas_used: U256,
        gas_price: U256,
        transactions: Vec<Transaction>,
    }
}

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        let result = 2 + 2;
        assert_eq!(result, 4);
    }
}