Struct KeyPair

pub struct KeyPair {
    pub private_key: Secp256r1PrivateKey,
    pub public_key: Secp256r1PublicKey,
}

Represents an Elliptic Curve Key Pair containing both a private and a public key.

Fields

private_key: Secp256r1PrivateKey

The private key component of the key pair.

public_key: Secp256r1PublicKey

The public key component of the key pair.

Implementations

impl KeyPair

pub fn new( private_key: Secp256r1PrivateKey, public_key: Secp256r1PublicKey, ) -> Self

Creates a new KeyPair instance given a private key and its corresponding public key.

Arguments

• private_key - A Secp256r1PrivateKey representing the private key.
• public_key - A Secp256r1PublicKey representing the public key.

pub fn private_key(&self) -> Secp256r1PrivateKey

pub fn public_key(&self) -> Secp256r1PublicKey

pub fn from_secret_key(private_key: &Secp256r1PrivateKey) -> Self

Derives a new KeyPair instance from just a private key. The public key is derived from the given private key.

Arguments

• private_key - A Secp256r1PrivateKey representing the private key.

pub fn private_key_bytes(&self) -> [u8; 32]

Returns the 32-byte representation of the private key.

pub fn public_key_bytes(&self) -> [u8; 64]

Returns the 64-byte uncompressed representation of the public key.

impl KeyPair

pub fn new_random() -> Self

Generates a new random KeyPair.

pub fn from_private_key(private_key: &[u8; 32]) -> Result<Self, CryptoError>

Creates an KeyPair from a given 32-byte private key.

Arguments

• private_key - A 32-byte slice representing the private key.

pub fn from_wif(wif: &str) -> Result<Self, CryptoError>

Creates an KeyPair from a given Wallet Import Format (WIF) string. This will use the private key encoded in the WIF to generate the key pair.

Arguments

• wif - A Wallet Import Format (WIF) string.

The WIF string should be in the format Kx... or Lx.... The key pair will be generated from the private key encoded in the WIF. The public key will be derived from the private key.

pub fn from_public_key(public_key: &[u8; 64]) -> Result<Self, CryptoError>

Creates an KeyPair from a given 65-byte public key. This will use a dummy private key internally.

Arguments

• public_key - A 65-byte slice representing the uncompressed public key.

pub fn export_as_wif(&self) -> String

Exports the key pair as a Wallet Import Format (WIF) string

Returns: The WIF encoding of this key pair

pub fn get_script_hash(&self) -> ScriptHash

pub fn get_address(&self) -> String

Trait Implementations

impl Clone for KeyPair

fn clone(&self) -> KeyPair

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPair

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

Formats the value using the given formatter.

impl PartialEq for KeyPair

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

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

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

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