Struct nostr_sdk::Keys

pub struct Keys { /* private fields */ }

Keys

Implementations

impl Keys

pub fn vanity<S>( prefixes: Vec<S, Global>, 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 from secret key.

pub fn generate() -> Keys

Generate new random Keys

pub fn generate_with_rng<R>(rng: &mut R) -> Keyswhere R: Rng + ?Sized,

Generate random Keys with custom Rng

pub fn generate_without_keypair<R>(rng: &mut R) -> Keyswhere R: Rng + ?Sized,

Generate random Keys with custom Rng and without KeyPair Useful for faster Keys generation (ex. vanity pubkey mining)

pub fn normalized_public_key(&self) -> Result<PublicKey, Error>

Get PublicKey

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

Sign schnorr Message

impl Keys

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

Initialize from secret key.

pub fn from_public_key(public_key: XOnlyPublicKey) -> Keys

Initialize with public key only (no secret key).

pub fn generate_with_ctx<C, R>(secp: &Secp256k1<C>, rng: &mut R) -> Keyswhere C: Signing, R: Rng + ?Sized,

Generate random Keys with custom Rng

pub fn generate_without_keypair_with_ctx<C, R>( secp: &Secp256k1<C>, rng: &mut R ) -> Keyswhere C: Signing, R: Rng + ?Sized,

Generate random Keys with custom Rng and without KeyPair Useful for faster Keys generation (ex. vanity pubkey mining)

pub fn public_key(&self) -> XOnlyPublicKey

Get XOnlyPublicKey

pub fn secret_key(&self) -> Result<SecretKey, Error>

Get secret key

pub fn normalized_public_key_with_ctx<C>( &self, secp: &Secp256k1<C> ) -> Result<PublicKey, Error>where C: Signing,

Get PublicKey

pub fn key_pair<C>(&self, secp: &Secp256k1<C>) -> Result<KeyPair, Error>where C: Signing,

Get keypair

If not exists, will be created

pub fn sign_schnorr_with_ctx<C, R>( &self, secp: &Secp256k1<C>, message: &Message, rng: &mut R ) -> Result<Signature, Error>where C: Signing, R: Rng + CryptoRng,

Sign schnorr Message

Trait Implementations

impl Clone for Keys

fn clone(&self) -> Keys

Returns a copy 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

fn from_mnemonic<S>( mnemonic: S, passphrase: Option<S> ) -> Result<Keys, <Keys as FromMnemonic>::Err>where S: Into<String>,

Derive keys from BIP-39 mnemonics (ENGLISH wordlist).

fn from_mnemonic_with_ctx<C>( secp: &Secp256k1<C>, mnemonic: &str, passphrase: Option<&str> ) -> Result<Keys, <Keys as FromMnemonic>::Err>where C: Signing,

Derive keys from BIP-39 mnemonics (ENGLISH wordlist).

type Err = Error

impl FromPkStr for Keys

fn from_pk_str(public_key: &str) -> Result<Keys, <Keys as FromPkStr>::Err>

Init Keys from hex or bech32 public key

type Err = Error

Error

impl FromSkStr for Keys

fn from_sk_str(secret_key: &str) -> Result<Keys, <Keys as FromSkStr>::Err>

Init Keys from hex or bech32 secret key

type Err = Error

Error

impl GenerateMnemonic for Keys

fn generate_mnemonic( word_count: usize ) -> Result<Mnemonic, <Keys as GenerateMnemonic>::Err>

Generate new mnemonic

type Err = Error

fn generate_mnemonic_with_rng<R>( rng: &mut R, word_count: usize ) -> Result<Mnemonic, <Keys as GenerateMnemonic>::Err>where R: RngCore,

impl PartialEq<Keys> for Keys

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

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

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 Copy for Keys

impl Eq for Keys

impl StructuralEq for Keys

impl StructuralPartialEq for Keys