Struct Key

pub struct Key { /* private fields */ }

| An encapsulated private key. |

Implementations

impl Key

pub fn set<T>(&mut self, pbegin: T, pend: T, compressed_in: bool)

| Initialize using begin and end iterators | to byte data. |

pub fn size(&self) -> u32

| Simple read-only vector-like interface. |

pub fn begin(&self) -> *const u8

pub fn end(&self) -> *const u8

pub fn is_valid(&self) -> bool

| Check whether this private key is valid. |

pub fn is_compressed(&self) -> bool

| Check whether the public key corresponding | to this private key is (to be) compressed. |

pub fn check(&mut self, vch: *const u8) -> bool

| Check whether the 32-byte array pointed | to by vch is valid keydata. |

pub fn make_new_key(&mut self, compressed_in: bool)

| Generate a new private key using a cryptographic | PRNG. |

pub fn negate(&mut self) -> bool

| Negate private key |

pub fn get_priv_key(&self) -> PrivKey

| Convert the private key to a CPrivKey | (serialized OpenSSL private key data). | | This is expensive. |

pub fn get_pub_key(&self) -> PubKey

| Compute the public key from a private | key. | | This is expensive. |

pub fn sign( &self, hash: &u256, vch_sig: &mut Vec<u8>, grind: Option<bool>, test_case: Option<u32>, ) -> bool

| Create a DER-serialized signature. | | The test_case parameter tweaks the | deterministic nonce. |

pub fn verify_pub_key(&self, pubkey: &PubKey) -> bool

| Verify thoroughly whether a private | key and a public key match. | | This is done using a different mechanism | than just regenerating it. |

pub fn sign_compact(&self, hash: &u256, vch_sig: &mut Vec<u8>) -> bool

| Create a compact signature (65 bytes), | which allows reconstructing the used | public key. | | The format is one header byte, followed | by two times 32 bytes for the serialized | r and s values. | | The header byte: 0x1B = first key with | even y, 0x1C = first key with odd y, 0x1D | = second key with even y, 0x1E = second | key with odd y, add 0x04 for compressed | keys. |

pub fn sign_schnorr( &self, hash: &u256, sig: &[u8], merkle_root: *const u256, aux: *const u256, ) -> bool

| Create a BIP-340 Schnorr signature, | for the xonly-pubkey corresponding | to *this, optionally tweaked by *merkle_root. | Additional nonce entropy can be provided | through aux. merkle_root is used to | optionally perform tweaking of the | private key, as specified in BIP341: | | - If merkle_root == nullptr: no tweaking | is done, sign with key directly (this | is used for signatures in BIP342 script). | | - If merkle_root->IsNull(): sign with | key + H_TapTweak(pubkey) (this is used | for key path spending when no scripts | are present). | | - Otherwise: sign with key + H_TapTweak(pubkey | || *merkle_root) (this is used for key | path spending, with specific | | Merkle root of the script tree). |

pub fn load( &mut self, seckey: &PrivKey, vch_pub_key: &PubKey, skip_check: Option<bool>, ) -> bool

| Load private key and check that public | key matches. |

pub fn derive( &self, key_child: &mut Key, cc_child: &mut ChainCode, n_child: u32, cc: &ChainCode, ) -> bool

| Derive BIP32 child key. |

Trait Implementations

impl Default for Key

fn default() -> Self

Construct an invalid private key.

impl PartialEq for Key

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Key