Struct avalanche_types::key::hot::Key

pub struct Key {
    pub secret_key: Option<SecretKey>,
    pub public_key: Option<PublicKey>,
    pub mnemonic_phrase: Option<String>,
    pub private_key: String,
    pub private_key_hex: String,
    pub short_address: Id,
    pub eth_address: String,
}

Fields

secret_key: Option<SecretKey>

public_key: Option<PublicKey>

mnemonic_phrase: Option<String>

Mnemonic phrase (optional).

private_key: String

AVAX wallet compatible private key. NEVER save mainnet-funded wallet keys here.

private_key_hex: String

Used for importing keys in MetaMask and subnet-cli. ref. https://github.com/ava-labs/subnet-cli/blob/5b69345a3fba534fb6969002f41c8d3e69026fed/internal/key/key.go#L238-L258 NEVER save mainnet-funded wallet keys here.

short_address: Id

ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/utils/hashing#PubkeyBytesToAddress

eth_address: String

ref. https://pkg.go.dev/github.com/ethereum/go-ethereum/common#Address

Implementations

impl Key

pub fn generate() -> Result<Self>

Generates a new Secp256k1 key.

pub fn from_private_key<S>(encoded_priv_key: S) -> Result<Self> where
    S: Into<String>, 

Loads the specified Secp256k1 key with CB58 encoding. Takes the “private_key” field in the “Key” struct.

pub fn from_private_key_raw<S>(raw: S) -> Result<Self> where
    S: AsRef<[u8]>, 

Loads the specified Secp256k1 key with CB58 encoding. Takes the “private_key” field in the “Key” struct.

pub fn from_private_key_eth<S>(encoded_priv_key: S) -> Result<Self> where
    S: AsRef<[u8]>, 

Loads the specified Secp256k1 key with hex encoding. Takes the “private_key” field in the “Key” struct.

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

pub fn short_address_bytes(&self) -> Result<Vec<u8>>

pub fn private_key_info_entry(
    &self,
    network_id: u32
) -> Result<PrivateKeyInfoEntry>

impl Key

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

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromStr for Key

ref. https://doc.rust-lang.org/std/str/trait.FromStr.html

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this 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 ==.

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

This method tests for !=.

impl ReadOnly for Key

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

fn get_address(&self, chain_id_alias: &str, network_id: u32) -> 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) -> Id

fn get_eth_address(&self) -> String

impl Serialize for Key

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl SignOnly for Key

fn sign_ecdsa_recoverable(&self, msg: &[u8]) -> Vec<u8>

Signs the message with the ECDSA secret key and appends the recovery code to the signature. 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

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key