Enum elements::dynafed::Params

pub enum Params {
    Null,
    Compact {
        signblockscript: Script,
        signblock_witness_limit: u32,
        elided_root: Midstate,
    },
    Full {
        signblockscript: Script,
        signblock_witness_limit: u32,
        fedpeg_program: Script,
        fedpegscript: Vec<u8>,
        extension_space: Vec<Vec<u8>>,
    },
}

Dynamic federations paramaters, as encoded in a block header

Variants

Null

Null entry, used to signal "no vote" as a proposal

Compact

Compact params where the fedpeg data and extension space are not included, and are assumed to be equal to the values from the previous block

Fields of Compact

signblockscript: Script

"scriptPubKey" used for block signing

signblock_witness_limit: u32

Maximum, in bytes, of the size of a blocksigning witness

elided_root: Midstate

Merkle root of extra data

Full

Full dynamic federations parameters

Fields of Full

signblockscript: Script

"scriptPubKey" used for block signing

signblock_witness_limit: u32

Maximum, in bytes, of the size of a blocksigning witness

fedpeg_program: Script

Untweaked scriptPubKey used for pegins

fedpegscript: Vec<u8>

For v0 fedpeg programs, the witness script of the untweaked pegin address. For future versions, this data has no defined meaning and will be considered "anyone can spend".

extension_space: Vec<Vec<u8>>

"Extension space" used by Liquid for PAK key entries

Methods

impl Params

pub fn is_null(&self) -> bool

Check whether this is Params::Null.

pub fn is_compact(&self) -> bool

Check whether this is Params::Compact.

pub fn is_full(&self) -> bool

Check whether this is Params::Full.

pub fn signblockscript(&self) -> Option<&Script>

Get the signblockscript. Is None for [Null] params.

pub fn signblock_witness_limit(&self) -> Option<u32>

Get the signblock_witness_limit. Is None for [Null] params.

pub fn fedpeg_program(&self) -> Option<&Script>

Get the fedpeg_program. Is None for non-[Full] params.

pub fn fedpegscript(&self) -> Option<&Vec<u8>>

Get the fedpegscript. Is None for non-[Full] params.

pub fn extension_space(&self) -> Option<&Vec<Vec<u8>>>

Get the extension_space. Is None for non-[Full] params.

pub fn elided_root(&self) -> Option<&Midstate>

Get the elided_root. Is None for non-[Compact] params.

pub fn calculate_root(&self) -> Midstate

Calculate the root of this Params.

pub fn into_compact(self) -> Option<Params>

Turns paramers into compact parameters. This returns self for compact params and None for null ones.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Decodable for Params

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

impl Encodable for Params

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format, should only ever error if the underlying Write errors. Returns the number of bytes written on success

impl Eq for Params

impl Hash for Params

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Params> for Params

fn eq(&self, other: &Params) -> bool

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

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

This method tests for !=.

impl StructuralEq for Params

impl StructuralPartialEq for Params