reth-primitives-traits 0.3.0

Common types in reth.
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

//! Helpers for recovering signers from a set of transactions

use crate::{transaction::signed::RecoveryError, Recovered, SignedTransaction};
use alloc::vec::Vec;
use alloy_consensus::transaction::SignerRecoverable;
use alloy_primitives::Address;

#[cfg(feature = "rayon")]
use rayon::prelude::{IntoParallelIterator, ParallelIterator};

/// Recovers a list of signers from a transaction list iterator.
///
/// Returns `Err(RecoveryError)`, if some transaction's signature is invalid.
///
/// When the `rayon` feature is enabled, recovery is performed in parallel.
#[cfg(feature = "rayon")]
pub fn recover_signers<'a, I, T>(txes: I) -> Result<Vec<Address>, RecoveryError>
where
    T: SignedTransaction,
    I: IntoParallelIterator<Item = &'a T>,
{
    txes.into_par_iter().map(|tx| tx.recover_signer()).collect()
}

/// Recovers a list of signers from a transaction list iterator.
///
/// Returns `Err(RecoveryError)`, if some transaction's signature is invalid.
#[cfg(not(feature = "rayon"))]
pub fn recover_signers<'a, I, T>(txes: I) -> Result<Vec<Address>, RecoveryError>
where
    T: SignedTransaction,
    I: IntoIterator<Item = &'a T>,
{
    txes.into_iter().map(|tx| tx.recover_signer()).collect()
}

/// Recovers a list of signers from a transaction list iterator _without ensuring that the
/// signature has a low `s` value_.
///
/// Returns `Err(RecoveryError)`, if some transaction's signature is invalid.
///
/// When the `rayon` feature is enabled, recovery is performed in parallel.
#[cfg(feature = "rayon")]
pub fn recover_signers_unchecked<'a, I, T>(txes: I) -> Result<Vec<Address>, RecoveryError>
where
    T: SignedTransaction,
    I: IntoParallelIterator<Item = &'a T>,
{
    txes.into_par_iter().map(|tx| tx.recover_signer_unchecked()).collect()
}

/// Recovers a list of signers from a transaction list iterator _without ensuring that the
/// signature has a low `s` value_.
///
/// Returns `Err(RecoveryError)`, if some transaction's signature is invalid.
#[cfg(not(feature = "rayon"))]
pub fn recover_signers_unchecked<'a, I, T>(txes: I) -> Result<Vec<Address>, RecoveryError>
where
    T: SignedTransaction,
    I: IntoIterator<Item = &'a T>,
{
    txes.into_iter().map(|tx| tx.recover_signer_unchecked()).collect()
}

/// Trait for items that can be used with [`try_recover_signers`].
#[cfg(feature = "rayon")]
pub trait TryRecoverItems: IntoParallelIterator {}

/// Trait for items that can be used with [`try_recover_signers`].
#[cfg(not(feature = "rayon"))]
pub trait TryRecoverItems: IntoIterator {}

#[cfg(feature = "rayon")]
impl<I: IntoParallelIterator> TryRecoverItems for I {}

#[cfg(not(feature = "rayon"))]
impl<I: IntoIterator> TryRecoverItems for I {}

/// Trait for decode functions that can be used with [`try_recover_signers`].
#[cfg(feature = "rayon")]
pub trait TryRecoverFn<Item, T>: Fn(Item) -> Result<T, RecoveryError> + Sync {}

/// Trait for decode functions that can be used with [`try_recover_signers`].
#[cfg(not(feature = "rayon"))]
pub trait TryRecoverFn<Item, T>: Fn(Item) -> Result<T, RecoveryError> {}

#[cfg(feature = "rayon")]
impl<Item, T, F: Fn(Item) -> Result<T, RecoveryError> + Sync> TryRecoverFn<Item, T> for F {}

#[cfg(not(feature = "rayon"))]
impl<Item, T, F: Fn(Item) -> Result<T, RecoveryError>> TryRecoverFn<Item, T> for F {}

/// Decodes and recovers a list of [`Recovered`] transactions from an iterator.
///
/// The `decode` closure transforms each item into a [`SignedTransaction`], which is then
/// recovered.
///
/// Returns an error if decoding or signature recovery fails for any transaction.
///
/// When the `rayon` feature is enabled, recovery is performed in parallel.
#[cfg(feature = "rayon")]
pub fn try_recover_signers<I, F, T>(items: I, decode: F) -> Result<Vec<Recovered<T>>, RecoveryError>
where
    I: IntoParallelIterator,
    F: Fn(I::Item) -> Result<T, RecoveryError> + Sync,
    T: SignedTransaction,
{
    items
        .into_par_iter()
        .map(|item| {
            let tx = decode(item)?;
            SignerRecoverable::try_into_recovered(tx)
        })
        .collect()
}

/// Decodes and recovers a list of [`Recovered`] transactions from an iterator.
///
/// The `decode` closure transforms each item into a [`SignedTransaction`], which is then
/// recovered.
///
/// Returns an error if decoding or signature recovery fails for any transaction.
#[cfg(not(feature = "rayon"))]
pub fn try_recover_signers<I, F, T>(items: I, decode: F) -> Result<Vec<Recovered<T>>, RecoveryError>
where
    I: IntoIterator,
    F: Fn(I::Item) -> Result<T, RecoveryError>,
    T: SignedTransaction,
{
    items
        .into_iter()
        .map(|item| {
            let tx = decode(item)?;
            SignerRecoverable::try_into_recovered(tx)
        })
        .collect()
}