Skip to main content

Signer

Struct Signer 

Source
pub struct Signer { /* private fields */ }
Expand description

Core interface responsible for managing keys, interfacing with the blockchain provider, assembling descriptors, estimating fees, and finalizing/signing transactions.

Without the provider feature the signer has no blockchain access: it can assemble, blind, sign and finalize a transaction it is handed, but it cannot discover UTXOs, look up a fee rate, or broadcast.

Implementations§

Source§

impl Signer

Source

pub fn new(mnemonic: &str, provider: Box<dyn ProviderTrait>) -> Signer

Creates a new Signer instance seeded from the provided mnemonic and paired with the specified provider.

§Panics

Panics if the mnemonic fails to parse, or if deriving the master private key fails.

Source

pub fn from_mnemonic(mnemonic: &str, network: SimplicityNetwork) -> Signer

Creates a Signer from a mnemonic and an explicit network, with no blockchain access.

This is the constructor a host with its own networking and its own key custody should use.

§Panics

Panics if the mnemonic fails to parse, or if deriving the master private key fails.

Source

pub fn send( &self, to: Script, amount: u64, ) -> Result<TxReceipt<'_>, SignerError>

Composes, funds, and broadcasts a standard network transaction sending the specified value of the primary policy asset.

§Errors

Returns a SignerError if compiling the inputs fails, there are insufficient funds/fees, or broadcast is rejected.

Source

pub fn broadcast( &self, tx: &FinalTransaction, ) -> Result<TxReceipt<'_>, SignerError>

Evaluates, funds, and broadcasts an already assembled FinalTransaction.

§Errors

Returns a SignerError if finalizing the payload fails or if the network rejects the broadcast.

Source

pub fn finalize( &self, tx: &FinalTransaction, ) -> Result<(Transaction, u64), SignerError>

Evaluates the input components of a FinalTransaction, iteratively selecting available wallet UTXOs to cover outputs and estimated fees.

§Errors

Returns a SignerError if the wallet contains insufficient funds to satisfy output values and target fee rates.

Source

pub fn finalize_strict( &self, tx: &FinalTransaction, fee_rate: f32, ) -> Result<(Transaction, u64), SignerError>

Verifies and finalizes a transaction against a strict target confirmation window (in blocks). This function also assumes that the transaction already includes the coin selection.

§Errors

Returns a SignerError if the assembled inputs do not meet dust limits or fail to cover the dynamically estimated required fee.

Source

pub fn estimate_fee( &self, tx: &FinalTransaction, fee_rate: f32, ) -> Result<u64, SignerError>

Reports what an assembled transaction would cost in fees at the given rate.

§Errors

Returns a SignerError if the transaction cannot be signed.

Source

pub fn get_provider(&self) -> Result<&dyn ProviderTrait, SignerError>

Returns a reference to the active configured network provider.

§Errors

Returns ProviderUnavailable when the signer was built without one.

Source

pub fn get_confidential_address(&self) -> Address

Returns the confidential elements address matching the local wallet logic.

§Panics

Panics if the SLIP77 descriptor cannot be generated or parsed, or if address derivation fails.

Source

pub fn get_address(&self) -> Address

Returns the standard unblinded address matching the local wallet logic.

§Panics

Panics if the WPKH descriptor cannot be generated or parsed, or if address derivation fails.

Source

pub fn get_utxos(&self) -> Result<Vec<UTXO>, SignerError>

Iterates against the network provider to select and unblind all known UTXOs.

§Errors

Returns a SignerError if querying the network or unblinding operations fail.

Source

pub fn get_utxos_asset(&self, asset: AssetId) -> Result<Vec<UTXO>, SignerError>

Finds all known UTXOs belonging to the specific AssetId.

§Errors

Returns a SignerError if network interaction or confidential output decryption fails.

Source

pub fn get_utxos_txid(&self, txid: Txid) -> Result<Vec<UTXO>, SignerError>

Finds all known UTXOs deriving from a targeted Txid.

§Errors

Returns a SignerError if querying the network fails.

Source

pub fn get_utxos_filter( &self, explicit_filter: &dyn Fn(&UTXO) -> bool, confidential_filter: &dyn Fn(&UTXO) -> bool, ) -> Result<Vec<UTXO>, SignerError>

Maps UTXOs retrieved from the provider through arbitrary functional filters. Separate filtering criteria apply explicitly vs confidentially.

§Errors

Returns a SignerError if retrieving remote outputs or executing confidential node unblinding throws an error.

Source

pub fn get_schnorr_public_key(&self) -> XOnlyPublicKey

Derives the X-Only public key specifically used for Schnorr and Taproot structures.

Source

pub fn get_ecdsa_public_key(&self) -> PublicKey

Resolves the standard format ECDSA public key.

Source

pub fn get_blinding_public_key(&self) -> PublicKey

Resolves the corresponding blinding public key.

Source

pub fn get_private_key(&self) -> PrivateKey

Internally derives and exposes the wallet’s signing active private key.

§Panics

Panics if the master private key or derivation path cannot be derived.

Source

pub fn get_private_key_at( &self, relative: Option<&DerivationPath>, ) -> PrivateKey

Derives the signing key at a path relative to the account path. None defaults to 0/0.

§Panics

Panics if the master private key or derivation path cannot be derived.

Source

pub fn get_blinding_private_key(&self) -> PrivateKey

Generates the private key linked to confidential payload blinding.

The generated PrivateKey is associated with the Test (non-Bitcoin/Liquid-mainnet) network kind. Retrieves the blinding private key derived from the master SLIP77 key and the script public key of the address.

§Panics

Panics if the master SLIP77 key cannot be derived.

Trait Implementations§

Source§

impl SignerTrait for Signer

Source§

fn sign_program( &self, pst: &PartiallySignedTransaction, program: &dyn ProgramTrait, input_index: usize, network: &SimplicityNetwork, derivation_path: Option<&DerivationPath>, message: &SigMessage, ) -> Result<Signature, SignerError>

Generates a Schnorr signature to satisfy a target Simplicity program input. Read more
Source§

fn sign_input( &self, pst: &PartiallySignedTransaction, input_index: usize, derivation_path: Option<&DerivationPath>, ) -> Result<(PublicKey, Signature), SignerError>

Generates an ECDSA signature to spend a standard transaction input. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Signer

§

impl !Send for Signer

§

impl !Sync for Signer

§

impl !UnwindSafe for Signer

§

impl Freeze for Signer

§

impl Unpin for Signer

§

impl UnsafeUnpin for Signer

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1:

renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V