use alloc::vec::Vec;
use alloy_primitives::Bloom;
use alloy_rlp::BufMut;
use core::fmt;
mod envelope;
pub use envelope::ReceiptEnvelope;
pub(crate) mod receipt2;
pub use receipt2::{EthereumReceipt, TxTy};
mod receipts;
pub use receipts::{Receipt, ReceiptWithBloom, Receipts};
mod status;
pub use status::Eip658Value;
use alloy_eips::{eip2718::Eip2718Result, Typed2718};
/// Bincode-compatible serde implementations for receipt types.
#[cfg(all(feature = "serde", feature = "serde-bincode-compat"))]
pub(crate) mod serde_bincode_compat {
pub use super::{
envelope::serde_bincode_compat::*, receipt2::serde_bincode_compat::*,
receipts::serde_bincode_compat::*,
};
}
/// Receipt is the result of a transaction execution.
#[doc(alias = "TransactionReceipt")]
#[auto_impl::auto_impl(&, Arc)]
pub trait TxReceipt: Clone + fmt::Debug + PartialEq + Eq + Send + Sync {
/// The associated log type.
type Log;
/// Returns the status or post state of the transaction.
///
/// ## Note
///
/// Use this method instead of [`TxReceipt::status`] when the transaction
/// is pre-[EIP-658].
///
/// [EIP-658]: https://eips.ethereum.org/EIPS/eip-658
fn status_or_post_state(&self) -> Eip658Value;
/// Returns true if the transaction was successful OR if the transaction is
/// pre-[EIP-658]. Results for transactions before [EIP-658] are not
/// reliable.
///
/// ## Note
///
/// Caution must be taken when using this method for deep-historical
/// receipts, as it may not accurately reflect the status of the
/// transaction. The transaction status is not knowable from the receipt
/// for transactions before [EIP-658].
///
/// This can be handled using [`TxReceipt::status_or_post_state`].
///
/// [EIP-658]: https://eips.ethereum.org/EIPS/eip-658
fn status(&self) -> bool;
/// Returns the bloom filter for the logs in the receipt. This operation
/// may be expensive.
fn bloom(&self) -> Bloom;
/// Returns the bloom filter for the logs in the receipt, if it is cheap to
/// compute.
fn bloom_cheap(&self) -> Option<Bloom> {
None
}
/// Returns [`ReceiptWithBloom`] with the computed bloom filter [`Self::bloom`] and a reference
/// to the receipt.
#[auto_impl(keep_default_for(&, Arc))]
fn with_bloom_ref(&self) -> ReceiptWithBloom<&Self> {
ReceiptWithBloom { logs_bloom: self.bloom(), receipt: self }
}
/// Consumes the type and converts it into [`ReceiptWithBloom`] with the computed bloom filter
/// [`Self::bloom`] and the receipt.
#[auto_impl(keep_default_for(&, Arc))]
fn into_with_bloom(self) -> ReceiptWithBloom<Self> {
ReceiptWithBloom { logs_bloom: self.bloom(), receipt: self }
}
/// Consumes the type and converts it into [`ReceiptWithBloom`] with the given bloom filter.
#[auto_impl(keep_default_for(&, Arc))]
fn into_with_bloom_unchecked(self, logs_bloom: Bloom) -> ReceiptWithBloom<Self> {
ReceiptWithBloom { logs_bloom, receipt: self }
}
/// Returns the cumulative gas used in the block after this transaction was executed.
fn cumulative_gas_used(&self) -> u64;
/// Returns the logs emitted by this transaction.
fn logs(&self) -> &[Self::Log];
/// Consumes the type and returns the logs emitted by this transaction as a vector.
#[auto_impl(keep_default_for(&, Arc))]
fn into_logs(self) -> Vec<Self::Log>
where
Self::Log: Clone,
{
self.logs().to_vec()
}
}
/// Receipt type that knows how to encode itself with a [`Bloom`] value.
#[auto_impl::auto_impl(&)]
pub trait RlpEncodableReceipt {
/// Returns the length of the receipt payload with the provided bloom filter.
fn rlp_encoded_length_with_bloom(&self, bloom: &Bloom) -> usize;
/// RLP encodes the receipt with the provided bloom filter.
fn rlp_encode_with_bloom(&self, bloom: &Bloom, out: &mut dyn BufMut);
}
/// Receipt type that knows how to decode itself with a [`Bloom`] value.
pub trait RlpDecodableReceipt: Sized {
/// RLP decodes receipt and [`Bloom`] into [`ReceiptWithBloom`] instance.
fn rlp_decode_with_bloom(buf: &mut &[u8]) -> alloy_rlp::Result<ReceiptWithBloom<Self>>;
}
/// Receipt type that knows its EIP-2718 encoding.
///
/// Main consumer of this trait is [`ReceiptWithBloom`]. It is expected that [`RlpEncodableReceipt`]
/// implementation for this type produces network encoding which is used by [`alloy_rlp::Encodable`]
/// implementation for [`ReceiptWithBloom`].
#[auto_impl::auto_impl(&)]
pub trait Eip2718EncodableReceipt: RlpEncodableReceipt + Typed2718 {
/// EIP-2718 encoded length with the provided bloom filter.
fn eip2718_encoded_length_with_bloom(&self, bloom: &Bloom) -> usize;
/// EIP-2718 encodes the receipt with the provided bloom filter.
fn eip2718_encode_with_bloom(&self, bloom: &Bloom, out: &mut dyn BufMut);
}
/// Receipt type that knows how to decode itself along with bloom from EIP-2718 format.
///
/// This is used to support [`alloy_eips::eip2718::Decodable2718`] implementation for
/// [`ReceiptWithBloom`].
pub trait Eip2718DecodableReceipt: Sized {
/// EIP-2718 decodes the receipt and bloom from the buffer.
fn typed_decode_with_bloom(ty: u8, buf: &mut &[u8]) -> Eip2718Result<ReceiptWithBloom<Self>>;
/// EIP-2718 decodes the receipt and bloom from the buffer.
fn fallback_decode_with_bloom(buf: &mut &[u8]) -> Eip2718Result<ReceiptWithBloom<Self>>;
}
#[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 vector from: https://eips.ethereum.org/EIPS/eip-2481
#[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);
// check that the rlp length equals the length of the expected rlp
assert_eq!(receipt.length(), expected.len());
assert_eq!(data, expected);
}
// Test vector from: https://eips.ethereum.org/EIPS/eip-2481
#[test]
fn decode_legacy_receipt() {
let data = hex!("f901668001b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f85ff85d940000000000000000000000000000000000000011f842a0000000000000000000000000000000000000000000000000000000000000deada0000000000000000000000000000000000000000000000000000000000000beef830100ff");
// EIP658Receipt
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();
// receipt.clone().to_compact(&mut data);
// let (decoded, _) = Receipt::from_compact(&data[..], data.len());
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);
}
}