Skip to main content

Beef

Struct Beef 

Source
pub struct Beef {
    pub version: u32,
    pub bumps: Vec<MerklePath>,
    pub transactions: HashMap<Hash, BeefTx>,
}
Expand description

A set of Transactions and their MerklePaths (BUMPs).

Fields§

§version: u32

BEEF version number (e.g. BEEF_V1 or BEEF_V2).

§bumps: Vec<MerklePath>

Merkle paths (BUMPs) proving transaction inclusion in blocks.

§transactions: HashMap<Hash, BeefTx>

Transactions keyed by their txid hash.

Implementations§

Source§

impl Beef

Source

pub fn new() -> Self

Create a new empty BEEF V2.

Source

pub fn new_v1() -> Self

Create a new empty BEEF V1.

Source

pub fn new_v2() -> Self

Create a new empty BEEF V2.

Source

pub fn from_hex(hex_str: &str) -> Result<Self, SpvError>

Parse a BEEF from a hex string.

Source

pub fn from_bytes(data: &[u8]) -> Result<Self, SpvError>

Parse a BEEF from bytes.

Source

pub fn to_bytes(&self) -> Result<Vec<u8>, SpvError>

Serialize this BEEF to bytes (V2 format).

Source

pub fn to_hex(&self) -> Result<String, SpvError>

Serialize to hex.

Source

pub fn find_transaction(&self, txid: &str) -> Option<&Transaction>

Find a transaction by txid hex string.

Source

pub fn find_bump(&self, txid: &str) -> Option<&MerklePath>

Find a BUMP by txid.

Source

pub fn find_bump_by_hash(&self, txid: &Hash) -> Option<&MerklePath>

Find a BUMP by txid hash.

Source

pub fn merge_bump(&mut self, bump: &MerklePath) -> Result<usize, SpvError>

Merge a BUMP, returning its index in the bumps array.

Source

pub fn is_valid(&self, allow_txid_only: bool) -> bool

Check if the BEEF is valid (all transactions traceable to BUMPs).

Source

pub fn verify( &self, chain_tracker: &dyn ChainTracker, allow_txid_only: bool, ) -> Result<bool, SpvError>

Verify the BEEF against a chain tracker.

Trait Implementations§

Source§

impl Clone for Beef

Source§

fn clone(&self) -> Beef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Beef

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Beef

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Beef

§

impl RefUnwindSafe for Beef

§

impl Send for Beef

§

impl Sync for Beef

§

impl Unpin for Beef

§

impl UnsafeUnpin for Beef

§

impl UnwindSafe for Beef

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V