feat: PartialEq bounds (#53)

* feat: PartialEq impls

* feat: Bundle PartialEq impl on hash

Author: julio4

examples/custom-bundle-type.rs

@@ -25,7 +25,7 @@ use {
 	std::sync::Arc,
 };
 
-#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 struct CustomPlatform;
 
 impl Platform for CustomPlatform {
@@ -280,6 +280,12 @@ fn transfer_tx(
 		.with_signer(signer.address())
 }
 
+impl PartialEq for CustomBundleType {
+	fn eq(&self, other: &Self) -> bool {
+		self.hash() == other.hash()
+	}
+}
+
 #[derive(Debug)]
 struct MinimumProfitNotMet {
 	min: U256,

src/payload/block.rs

@@ -45,6 +45,12 @@ impl<P: Platform> Clone for BlockContext<P> {
 	}
 }
 
+impl<P: Platform> PartialEq for BlockContext<P> {
+	fn eq(&self, other: &Self) -> bool {
+		Arc::ptr_eq(&self.inner, &other.inner)
+	}
+}
+
 /// Constructors
 impl<P: Platform> BlockContext<P> {
 	/// To create a new [`BlockContext`], we need:

src/payload/checkpoint.rs

@@ -294,6 +294,7 @@ impl<P: Platform> IntoIterator for &Checkpoint<P> {
 
 /// Describes the type of state mutation that was applied to the previous
 /// checkpoint to create this checkpoint.
+#[derive(Debug, PartialEq)]
 enum Mutation<P: Platform> {
 	/// A checkpoint that indicates that any prior checkpoints are immutable and
 	/// should not be discarded or reordered. An example of this would be placing

src/payload/exec.rs

@@ -53,7 +53,7 @@ pub enum ExecutionError<P: Platform> {
 
 /// Describes an atomic unit of execution that can be used to create a state
 /// transition checkpoint.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum Executable<P: Platform> {
 	// Individual transaction
 	Transaction(Recovered<types::Transaction<P>>),
@@ -372,7 +372,7 @@ impl<P: PlatformWithRpcTypes> IntoExecutable<P, Variant<7>>
 ///
 /// Types implementing this trait provide access to the individual results of
 /// transaction executions that make up this overall result.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct ExecutionResult<P: Platform> {
 	/// The executable used to produce this result.
 	source: Executable<P>,

src/platform/bundle/flashbots.rs

@@ -238,6 +238,13 @@ impl<P: Platform> FlashbotsBundle<P> {
 	}
 }
 
+/// `PartialEq` by bundle hash
+impl<P: Platform> PartialEq for FlashbotsBundle<P> {
+	fn eq(&self, other: &Self) -> bool {
+		self.hash() == other.hash()
+	}
+}
+
 impl<P: Platform> Serialize for FlashbotsBundle<P> {
 	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
 	where

src/platform/bundle/mod.rs

@@ -29,7 +29,7 @@ pub use ext::BundleExt;
 ///
 /// [`eth_sendBundle`]: https://docs.flashbots.net/flashbots-auction/searchers/advanced/rpc-endpoint#eth_sendbundle
 pub trait Bundle<P: Platform>:
-	Serialize + DeserializeOwned + Clone + Debug + Send + Sync + 'static
+	Serialize + DeserializeOwned + Clone + PartialEq + Debug + Send + Sync + 'static
 {
 	type PostExecutionError: core::error::Error + Send + Sync + 'static;
 

src/platform/ethereum/mod.rs

@@ -62,7 +62,7 @@ mod limits;
 mod pool;
 
 /// Platform definition for ethereum mainnet.
-#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 pub struct Ethereum;
 
 impl Platform for Ethereum {

src/platform/mod.rs

@@ -44,6 +44,7 @@ pub trait Platform:
 	Sized
 	+ Default
 	+ Clone
+	+ PartialEq
 	+ Serialize
 	+ DeserializeOwned
 	+ core::fmt::Debug

src/platform/optimism/mod.rs

@@ -24,7 +24,7 @@ mod limits;
 pub use limits::OptimismDefaultLimits;
 
 /// Platform definition for Optimism Rollup chains.
-#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 pub struct Optimism;
 
 impl Platform for Optimism {