Struct epic_keychain::view_key::ViewKey

source · [−]

pub struct ViewKey {
    pub is_floo: bool,
    pub depth: u8,
    pub child_number: ChildNumber,
    pub rewind_hash: Vec<u8>,
    /* private fields */
}

Expand description

Key that can be used to scan the chain for owned outputs This is a public key, meaning it cannot be used to spend those outputs At the moment only depth 0 keys can be used

Fields

is_floo: bool

Whether this view key is meant for floonet or not

depth: u8

How many derivations this key is from the master (which is 0)

child_number: ChildNumber

Child number of the key used to derive from parent (0 for master)

rewind_hash: Vec<u8>

Hash used to generate rewind nonce

Implementations

impl ViewKey

pub fn create<K, H>(
    keychain: &K,
    ext_key: ExtendedPrivKey,
    hasher: &mut H,
    is_floo: bool
) -> Result<Self, Error> where
    K: Keychain,
    H: BIP32Hasher,

pub fn ckd_pub<H>(
    &self,
    secp: &Secp256k1,
    hasher: &mut H,
    i: ChildNumber
) -> Result<Self, Error> where
    H: BIP32Hasher,

pub fn commit(
    &self,
    secp: &Secp256k1,
    amount: u64,
    switch: &SwitchCommitmentType
) -> Result<PublicKey, Error>

Trait Implementations

impl Clone for ViewKey

fn clone(&self) -> ViewKey

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for ViewKey

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

Formats the value using the given formatter. Read more

impl PartialEq<ViewKey> for ViewKey

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

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

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

This method tests for !=.

impl Eq for ViewKey

impl StructuralEq for ViewKey

impl StructuralPartialEq for ViewKey

Auto Trait Implementations

impl RefUnwindSafe for ViewKey

impl Send for ViewKey

impl Sync for ViewKey

impl Unpin for ViewKey

impl UnwindSafe for ViewKey

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> CloneAny for T where
T: Any + Clone,

fn clone_any(&self) -> Box<dyn CloneAny + 'static, Global>

fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where
T: Send,

fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where
T: Sync,

fn clone_any_send_sync(
&self
) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where
T: Send + Sync,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> DebugAny for T where
T: Any + Debug,

impl<T> Erased for T

impl<T> UnsafeAny for T where
T: Any,