Struct Keys 

pub struct Keys {
    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>,

👎Deprecated since 0.39.0

Generate new vanity public key

impl Keys

pub fn new(secret_key: SecretKey) -> Keys

Construct from a secret key.

This method internally constructs the Keypair and derives the PublicKey.

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

where C: Signing,

Construct from a secret key.

This method internally constructs the Keypair and derives the PublicKey.

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

Parse secret key and construct keys.

Check SecretKey::parse to learn more about secret key parsing.

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

where C: Signing,

Parse secret key and construct keys.

Check SecretKey::parse to learn more about secret key parsing.

pub fn generate() -> Keys

Generate random keys

This constructor uses 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 public_key(&self) -> PublicKey

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 uses 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 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 NostrSigner for Keys

Available on crate feature std only.

fn backend(&self) -> SignerBackend<'_>

Signer backend

fn get_public_key( &self, ) -> Pin<Box<dyn Future<Output = Result<PublicKey, SignerError>> + Send + '_>>

Get signer public key

fn sign_event( &self, unsigned: UnsignedEvent, ) -> Pin<Box<dyn Future<Output = Result<Event, SignerError>> + Send + '_>>

Sign an unsigned event

fn nip04_encrypt<'a>( &'a self, _public_key: &'a PublicKey, _content: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, SignerError>> + Send + 'a>>

NIP04 encrypt (deprecate and unsecure)

fn nip04_decrypt<'a>( &'a self, _public_key: &'a PublicKey, _content: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, SignerError>> + Send + 'a>>

NIP04 decrypt

fn nip44_encrypt<'a>( &'a self, _public_key: &'a PublicKey, _content: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, SignerError>> + Send + 'a>>

NIP44 encrypt

fn nip44_decrypt<'a>( &'a self, _public_key: &'a PublicKey, _content: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, SignerError>> + Send + 'a>>

NIP44 decrypt

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