serai/processor/primitives/src/block.rs

use core::fmt::Debug;

use group::{Group, GroupEncoding};

use crate::{Id, Address, ReceivedOutput};

/// A block header from an external network.
pub trait BlockHeader: Send + Sync + Sized + Clone + Debug {
  /// The ID of this block.
  ///
  /// This is fixed to 32-bytes and is expected to be cryptographically binding with 128-bit
  /// security. This is not required to be the ID used natively by the external network.
  fn id(&self) -> [u8; 32];
  /// The ID of the parent block.
  fn parent(&self) -> [u8; 32];
}

/// A block from an external network.
///
/// A block is defined as a consensus event associated with a set of transactions. It is not
/// necessary to literally define it as whatever the external network defines as a block. For
/// external networks which finalize block(s), this block type should be a representation of all
/// transactions within a period finalization (whether block or epoch).
#[async_trait::async_trait]
pub trait Block: Send + Sync + Sized + Clone + Debug {
  /// The type used for this block's header.
  type Header: BlockHeader;

  /// The type used to represent keys on this external network.
  type Key: Group + GroupEncoding;
  /// The type used to represent addresses on this external network.
  type Address: Address;
  /// The type used to represent received outputs on this external network.
  type Output: ReceivedOutput<Self::Key, Self::Address>;

  /// The ID of this block.
  fn id(&self) -> [u8; 32];

  /// Scan all outputs within this block to find the outputs spendable by this key.
  fn scan_for_outputs(&self, key: Self::Key) -> Vec<Self::Output>;
}