use alloy_primitives::Bloom;
use alloy_rlp::BufMut;
use core::fmt;
mod envelope;
pub use envelope::ReceiptEnvelope;
mod receipts;
pub use receipts::{Receipt, ReceiptWithBloom, Receipts};
mod status;
pub use status::Eip658Value;
use crate::Typed2718;
#[doc(alias = "TransactionReceipt")]
#[auto_impl::auto_impl(&, Arc)]
pub trait TxReceipt: Clone + fmt::Debug + PartialEq + Eq + Send + Sync {
type Log;
fn status_or_post_state(&self) -> Eip658Value;
fn status(&self) -> bool;
fn bloom(&self) -> Bloom;
fn bloom_cheap(&self) -> Option<Bloom> {
None
}
#[auto_impl(keep_default_for(&, Arc))]
fn with_bloom_ref(&self) -> ReceiptWithBloom<&Self> {
ReceiptWithBloom { logs_bloom: self.bloom(), receipt: self }
}
#[auto_impl(keep_default_for(&, Arc))]
fn into_with_bloom(self) -> ReceiptWithBloom<Self> {
ReceiptWithBloom { logs_bloom: self.bloom(), receipt: self }
}
fn cumulative_gas_used(&self) -> u64;
fn logs(&self) -> &[Self::Log];
}
#[auto_impl::auto_impl(&)]
pub trait RlpEncodableReceipt {
fn rlp_encoded_length_with_bloom(&self, bloom: &Bloom) -> usize;
fn rlp_encode_with_bloom(&self, bloom: &Bloom, out: &mut dyn BufMut);
}
pub trait RlpDecodableReceipt: Sized {
fn rlp_decode_with_bloom(buf: &mut &[u8]) -> alloy_rlp::Result<ReceiptWithBloom<Self>>;
}
#[auto_impl::auto_impl(&)]
pub trait Eip2718EncodableReceipt: RlpEncodableReceipt + Typed2718 {
fn eip2718_encoded_length_with_bloom(&self, bloom: &Bloom) -> usize;
fn eip2718_encode_with_bloom(&self, bloom: &Bloom, out: &mut dyn BufMut);
}
#[cfg(test)]
mod tests {
use super::*;
use alloy_eips::eip2718::Encodable2718;
use alloy_primitives::{address, b256, bytes, hex, Log, LogData};
use alloy_rlp::{Decodable, Encodable};
#[test]
fn encode_legacy_receipt() {
let expected = hex!("f901668001b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f85ff85d940000000000000000000000000000000000000011f842a0000000000000000000000000000000000000000000000000000000000000deada0000000000000000000000000000000000000000000000000000000000000beef830100ff");
let mut data = vec![];
let receipt =
ReceiptEnvelope::Legacy(ReceiptWithBloom {
receipt: Receipt {
cumulative_gas_used: 0x1,
logs: vec![Log {
address: address!("0000000000000000000000000000000000000011"),
data: LogData::new_unchecked(
vec![
b256!("000000000000000000000000000000000000000000000000000000000000dead"),
b256!("000000000000000000000000000000000000000000000000000000000000beef"),
],
bytes!("0100ff"),
),
}],
status: false.into(),
},
logs_bloom: [0; 256].into(),
});
receipt.network_encode(&mut data);
assert_eq!(receipt.length(), expected.len());
assert_eq!(data, expected);
}
#[test]
fn decode_legacy_receipt() {
let data = hex!("f901668001b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f85ff85d940000000000000000000000000000000000000011f842a0000000000000000000000000000000000000000000000000000000000000deada0000000000000000000000000000000000000000000000000000000000000beef830100ff");
let expected =
ReceiptWithBloom {
receipt: Receipt {
cumulative_gas_used: 0x1,
logs: vec![Log {
address: address!("0000000000000000000000000000000000000011"),
data: LogData::new_unchecked(
vec![
b256!("000000000000000000000000000000000000000000000000000000000000dead"),
b256!("000000000000000000000000000000000000000000000000000000000000beef"),
],
bytes!("0100ff"),
),
}],
status: false.into(),
},
logs_bloom: [0; 256].into(),
};
let receipt = ReceiptWithBloom::decode(&mut &data[..]).unwrap();
assert_eq!(receipt, expected);
}
#[test]
fn gigantic_receipt() {
let receipt = Receipt {
cumulative_gas_used: 16747627,
status: true.into(),
logs: vec![
Log {
address: address!("4bf56695415f725e43c3e04354b604bcfb6dfb6e"),
data: LogData::new_unchecked(
vec![b256!(
"c69dc3d7ebff79e41f525be431d5cd3cc08f80eaf0f7819054a726eeb7086eb9"
)],
vec![1; 0xffffff].into(),
),
},
Log {
address: address!("faca325c86bf9c2d5b413cd7b90b209be92229c2"),
data: LogData::new_unchecked(
vec![b256!(
"8cca58667b1e9ffa004720ac99a3d61a138181963b294d270d91c53d36402ae2"
)],
vec![1; 0xffffff].into(),
),
},
],
}
.with_bloom();
let len = receipt.length();
let mut data = Vec::with_capacity(receipt.length());
receipt.encode(&mut data);
assert_eq!(data.len(), len);
let decoded = ReceiptWithBloom::decode(&mut &data[..]).unwrap();
assert_eq!(decoded, receipt);
}
#[test]
fn can_encode_by_reference() {
let receipt: Receipt =
Receipt { cumulative_gas_used: 16747627, status: true.into(), logs: vec![] };
let encoded_ref = alloy_rlp::encode(&ReceiptWithBloom {
receipt: &receipt,
logs_bloom: receipt.bloom_slow(),
});
let encoded =
alloy_rlp::encode(&ReceiptWithBloom { logs_bloom: receipt.bloom_slow(), receipt });
assert_eq!(encoded, encoded_ref);
}
}