Struct elements::PeginData

pub struct PeginData<'tx> {
    pub outpoint: OutPoint,
    pub value: u64,
    pub asset: AssetId,
    pub genesis_hash: BlockHash,
    pub claim_script: &'tx [u8],
    pub tx: &'tx [u8],
    pub merkle_proof: &'tx [u8],
    pub referenced_block: BlockHash,
}

Parsed data from a transaction input’s pegin witness

Fields

outpoint: OutPoint

Reference to the pegin output on the mainchain

value: u64

The value, in satoshis, of the pegin

asset: AssetId

Asset type being pegged in

genesis_hash: BlockHash

Hash of genesis block of originating blockchain

claim_script: &'tx [u8]

The claim script that we should hash to tweak our address. Unparsed to avoid unnecessary allocation and copying. Typical use is simply to feed it raw into a hash function.

tx: &'tx [u8]

Mainchain transaction; not parsed to save time/memory since the parsed transaction is typically not useful without auxiliary data (e.g. knowing how to compute pegin addresses for the sidechain).

merkle_proof: &'tx [u8]

Merkle proof of transaction inclusion; also not parsed

referenced_block: BlockHash

The Bitcoin block that the pegin output appears in; scraped from the transaction inclusion proof

Implementations

impl<'tx> PeginData<'tx>

pub fn from_pegin_witness( pegin_witness: &'tx [Vec<u8>], prevout: OutPoint ) -> Result<PeginData<'tx>, &'static str>

Construct the pegin data from a pegin witness. Returns None if not a valid pegin witness.

pub fn to_pegin_witness(&self) -> Vec<Vec<u8>>

Construct a pegin witness from the pegin data.

pub fn parse_tx(&self) -> Result<Transaction, Error>

Parse the mainchain tx provided as pegin data.

pub fn parse_merkle_proof(&self) -> Result<MerkleBlock, Error>

Parse the merkle inclusion proof provided as pegin data.

Trait Implementations

impl<'tx> Clone for PeginData<'tx>

fn clone(&self) -> PeginData<'tx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tx> Debug for PeginData<'tx>

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

Formats the value using the given formatter.

impl<'tx> Hash for PeginData<'tx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'tx> PartialEq for PeginData<'tx>

fn eq(&self, other: &PeginData<'tx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tx> Copy for PeginData<'tx>

impl<'tx> Eq for PeginData<'tx>

impl<'tx> StructuralPartialEq for PeginData<'tx>