fedimint_core

Trait BitcoinHash

source
pub trait BitcoinHash:
    Copy
    + Clone
    + PartialEq
    + Eq
    + PartialOrd
    + Ord
    + Hash
    + Debug
    + Display
    + LowerHex
    + Index<RangeFull, Output = [u8], Output = [u8], Output = [u8], Output = [u8], Output = u8>
    + Index<RangeFrom<usize>>
    + Index<RangeTo<usize>>
    + Index<Range<usize>>
    + Index<usize>
    + Borrow<[u8]> {
    type Engine: HashEngine;
    type Bytes: FromHex + Copy;

    const LEN: usize;
    const DISPLAY_BACKWARD: bool = false;

    // Required methods
    fn from_engine(e: Self::Engine) -> Self;
    fn from_slice(sl: &[u8]) -> Result<Self, Error>;
    fn to_byte_array(self) -> Self::Bytes;
    fn as_byte_array(&self) -> &Self::Bytes;
    fn from_byte_array(bytes: Self::Bytes) -> Self;
    fn all_zeros() -> Self;

    // Provided methods
    fn engine() -> Self::Engine { ... }
    fn hash(data: &[u8]) -> Self { ... }
}
Expand description

Trait which applies to hashes of all types.

Required Associated Constants§

source

const LEN: usize

Length of the hash, in bytes.

Provided Associated Constants§

source

const DISPLAY_BACKWARD: bool = false

Flag indicating whether user-visible serializations of this hash should be backward. For some reason Satoshi decided this should be true for Sha256dHash, so here we are.

Required Associated Types§

source

type Engine: HashEngine

A hashing engine which bytes can be serialized into. It is expected to implement the io::Write trait, and to never return errors under any conditions.

source

type Bytes: FromHex + Copy

The byte array that represents the hash internally.

Required Methods§

source

fn from_engine(e: Self::Engine) -> Self

Produces a hash from the current state of a given engine.

source

fn from_slice(sl: &[u8]) -> Result<Self, Error>

Copies a byte slice into a hash object.

source

fn to_byte_array(self) -> Self::Bytes

Returns the underlying byte array.

source

fn as_byte_array(&self) -> &Self::Bytes

Returns a reference to the underlying byte array.

source

fn from_byte_array(bytes: Self::Bytes) -> Self

Constructs a hash from the underlying byte array.

source

fn all_zeros() -> Self

Returns an all zero hash.

An all zeros hash is a made up construct because there is not a known input that can create it, however it is used in various places in Bitcoin e.g., the Bitcoin genesis block’s previous blockhash and the coinbase transaction’s outpoint txid.

Provided Methods§

source

fn engine() -> Self::Engine

Constructs a new engine.

source

fn hash(data: &[u8]) -> Self

Hashes some bytes.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl Hash for LegacySighash

source§

impl Hash for SegwitV0Sighash

source§

impl Hash for TapSighash

source§

impl Hash for BlockHash

source§

impl Hash for FilterHash

source§

impl Hash for FilterHeader

source§

impl Hash for PubkeyHash

source§

impl Hash for ScriptHash

source§

impl Hash for TxMerkleNode

source§

impl Hash for Txid

source§

impl Hash for WPubkeyHash

source§

impl Hash for WScriptHash

source§

impl Hash for WitnessCommitment

source§

impl Hash for WitnessMerkleNode

source§

impl Hash for Wtxid

source§

impl Hash for XpubIdentifier

source§

impl Hash for TapLeafHash

source§

impl Hash for TapNodeHash

source§

impl Hash for TapTweakHash

source§

impl Hash for Hash

Implementors§

source§

impl Hash for bitcoin_hashes::hash160::Hash

source§

impl Hash for bitcoin_hashes::ripemd160::Hash

source§

impl Hash for bitcoin_hashes::sha1::Hash

source§

impl Hash for bitcoin_hashes::sha256::Hash

source§

impl Hash for bitcoin_hashes::sha256d::Hash

source§

impl Hash for bitcoin_hashes::sha512::Hash

source§

impl Hash for bitcoin_hashes::sha512_256::Hash

source§

impl Hash for bitcoin_hashes::siphash24::Hash

source§

impl Hash for TransactionId

source§

const LEN: usize = 32usize

source§

const DISPLAY_BACKWARD: bool = false

source§

type Engine = <Hash as Hash>::Engine

source§

type Bytes = <Hash as Hash>::Bytes

source§

impl<T> Hash for Hmac<T>
where T: Hash,

source§

const LEN: usize = T::LEN

source§

type Engine = HmacEngine<T>

source§

type Bytes = <T as Hash>::Bytes

source§

impl<T> Hash for bitcoin_hashes::sha256t::Hash<T>
where T: Tag,