Struct NostrKeys 

pub struct NostrKeys {
    pub public_key: PublicKey,
    /* private fields */
}

Nostr keys

Fields

public_key: PublicKey

Public key

Implementations

impl Keys

pub fn vanity<S>( prefixes: Vec<S>, bech32: bool, num_cores: usize, ) -> Result<Keys, Error>

where S: Into<String>,

Generate new vanity public key

impl Keys

pub fn new(secret_key: SecretKey) -> Keys

Initialize nostr keys from secret key.

This method internally construct the Keypair and derive the PublicKey.

pub fn new_with_ctx<C>(secp: &Secp256k1<C>, secret_key: SecretKey) -> Keys

where C: Signing,

Initialize nostr keys from secret key.

This method internally construct the Keypair and derive the PublicKey.

pub fn parse<S>(secret_key: S) -> Result<Keys, Error>

where S: AsRef<str>,

Parse secret key from hex or bech32 and compose keys

pub fn parse_with_ctx<C, S>( secp: &Secp256k1<C>, secret_key: S, ) -> Result<Keys, Error>

where C: Signing, S: AsRef<str>,

Parse secret key from hex or bech32 and compose keys

pub fn generate() -> Keys

Generate random keys

This constructor use a random number generator that retrieves randomness from the operating system (see OsRng).

Use Keys::generate_with_rng to specify a custom random source.

Check Keys::generate_with_ctx to learn more about how this constructor works internally.

pub fn generate_with_rng<R>(rng: &mut R) -> Keys

where R: Rng + ?Sized,

Generate random keys using a custom random source

Check Keys::generate_with_ctx to learn more about how this constructor works internally.

pub fn generate_with_ctx<C, R>(secp: &Secp256k1<C>, rng: &mut R) -> Keys

where C: Signing, R: Rng + ?Sized,

Generate random keys

Generate random keys without construct the Keypair. This allows faster keys generation (i.e. for vanity pubkey mining). The Keypair will be automatically created when needed and stored in a cell.

pub fn generate_without_keypair_with_ctx<C, R>( secp: &Secp256k1<C>, rng: &mut R, ) -> Keys

where C: Signing, R: Rng + ?Sized,

👎Deprecated since 0.35.0: Use generate_with_ctx instead

Replaced by Keys::generate_with_ctx

pub fn generate_without_keypair<R>(rng: &mut R) -> Keys

where R: Rng + ?Sized,

👎Deprecated since 0.35.0: Use generate or generate_with_rng instead

Replaced by Keys::generate_with_rng

pub fn public_key(&self) -> PublicKey

Get public key

pub fn public_key_ref(&self) -> &PublicKey

👎Deprecated since 0.35.0

Get public key

pub fn secret_key(&self) -> &SecretKey

Get secret key

pub fn key_pair<C>(&self, secp: &Secp256k1<C>) -> &Keypair

where C: Signing,

Get keypair

pub fn sign_schnorr(&self, message: &Message) -> Signature

Creates a schnorr signature of the Message.

This method use a random number generator that retrieves randomness from the operating system (see OsRng).

pub fn sign_schnorr_with_ctx<C, R>( &self, secp: &Secp256k1<C>, message: &Message, rng: &mut R, ) -> Signature

where C: Signing, R: Rng + CryptoRng,

Creates a schnorr signature of the Message using a custom random number generation source.

Trait Implementations

impl Clone for Keys

fn clone(&self) -> Keys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keys

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

Formats the value using the given formatter.

impl FromMnemonic for Keys

type Err = Error

Error

fn from_mnemonic_with_ctx<C, S>( secp: &Secp256k1<C>, mnemonic: S, passphrase: Option<S>, account: Option<u32>, type: Option<u32>, index: Option<u32>, ) -> Result<Keys, <Keys as FromMnemonic>::Err>

where C: Signing, S: AsRef<str>,

Derive from BIP-39 mnemonics with custom account (ENGLISH wordlist).

fn from_mnemonic<S>( mnemonic: S, passphrase: Option<S>, ) -> Result<Self, Self::Err>

where S: AsRef<str>,

Derive from BIP-39 mnemonics (ENGLISH wordlist).

fn from_mnemonic_with_account<S>( mnemonic: S, passphrase: Option<S>, account: Option<u32>, ) -> Result<Self, Self::Err>

where S: AsRef<str>,

Derive from BIP-39 mnemonics with custom account (ENGLISH wordlist).

fn from_mnemonic_advanced<S>( mnemonic: S, passphrase: Option<S>, account: Option<u32>, type: Option<u32>, index: Option<u32>, ) -> Result<Self, Self::Err>

where S: AsRef<str>,

Derive from BIP-39 mnemonics with custom account, type and/or index (ENGLISH wordlist).

impl FromStr for Keys

Available on crate feature std only.

fn from_str(secret_key: &str) -> Result<Keys, <Keys as FromStr>::Err>

Try to parse Keys from secret key hex or bech32

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Keys

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Keys

fn cmp(&self, other: &Keys) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Keys

fn eq(&self, other: &Keys) -> 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 PartialOrd for Keys

fn partial_cmp(&self, other: &Keys) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Keys