Struct avalanche_types::key::secp256k1::private_key::Key

pub struct Key(_);

Represents “k256::SecretKey” and “k256::ecdsa::SigningKey”.

Implementations

impl Key

pub fn generate() -> Result<Self>

Generates a private key from random bytes.

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

Converts the private key to raw scalar bytes.

pub fn from_bytes(raw: &[u8]) -> Result<Self>

Loads the private key from the raw scalar bytes.

pub fn to_hex(&self) -> String

Hex-encodes the raw private key to string with “0x” prefix (e.g., Ethereum).

pub fn from_hex<S>(s: S) -> Result<Self>where
    S: Into<String>,

Loads the private key from a hex-encoded string (e.g., Ethereum).

pub fn to_cb58(&self) -> String

Encodes the raw private key to string with “PrivateKey-” prefix (e.g., Avalanche).

pub fn from_cb58<S>(s: S) -> Result<Self>where
    S: Into<String>,

Loads the private key from a CB58-encoded string (e.g., Avalanche). Once decoded and with its “PrivateKey-” prefix removed, the length must be 32-byte.

pub fn to_public_key(&self) -> PublicKey

Derives the public key from this private key.

pub fn to_info(&self, network_id: u32) -> Result<Info>

Converts to Info.

pub fn sign_digest(&self, digest: &[u8]) -> Result<Sig>

Signs the 32-byte SHA256 output message with the ECDSA private key and the recoverable code. “github.com/decred/dcrd/dcrec/secp256k1/v3/ecdsa.SignCompact” outputs 65-byte signature. ref. “avalanchego/utils/crypto.PrivateKeySECP256K1R.SignHash” ref. https://github.com/rust-bitcoin/rust-secp256k1/blob/master/src/ecdsa/recovery.rs

pub fn to_ethers_signing_key(&self) -> Result<EthersSigningKey>

impl Key

pub fn from_mnemonic_phrase<S>(phrase: S, derive_path: S) -> Result<Self>where
    S: AsRef<str>,

Loads the private key from the mnemonic phrase.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

ref. https://doc.rust-lang.org/std/string/trait.ToString.html ref. https://doc.rust-lang.org/std/fmt/trait.Display.html Use “Self.to_string()” to directly invoke this

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

Formats the value using the given formatter.

impl From<&Key> for Info

fn from(sk: &Key) -> Self

Converts to this type from the input type.

impl From<Key> for SecretKey

fn from(s: Key) -> Self

Converts to this type from the input type.

impl From<SecretKey<Secp256k1>> for Key

fn from(s: SecretKey) -> Self

Converts to this type from the input type.

impl PartialEq<Key> for Key

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

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

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

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

impl ReadOnly for Key

ref. https://doc.rust-lang.org/book/ch10-02-traits.html

fn get_address(&self, network_id: u32, chain_id_alias: &str) -> Result<String>

Implements “crypto.PublicKeySECP256K1R.Address()” and “formatting.FormatAddress”. “human readable part” (hrp) must be valid output from “constants.GetHRP(networkID)”. ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/utils/constants

fn get_short_address(&self) -> Result<Id>

fn get_short_address_bytes(&self) -> Result<Vec<u8>>

fn get_eth_address(&self) -> String

fn get_h160_address(&self) -> H160

impl SignOnly for Key

fn sign_digest<'life0, 'life1, 'async_trait>(
    &'life0 self,
    msg: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<[u8; 65]>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Signs the 32-byte SHA256 output message with the ECDSA private key and the recoverable code. “github.com/decred/dcrd/dcrec/secp256k1/v3/ecdsa.SignCompact” outputs 65-byte signature. TODO: Use “async” to support AWS KMS and ledger. ref. “avalanchego/utils/crypto.PrivateKeySECP256K1R.SignHash” ref. https://github.com/rust-bitcoin/rust-secp256k1/blob/master/src/ecdsa/recovery.rs ref. https://docs.rs/secp256k1/latest/secp256k1/struct.SecretKey.html#method.sign_ecdsa ref. https://docs.rs/secp256k1/latest/secp256k1/struct.Message.html ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/utils/crypto#PrivateKeyED25519.SignHash

fn ethers_signing_key(&self) -> Result<EthersSigningKey>

Returns the ethers signing key.

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key