Struct Signer 

pub struct Signer(/* private fields */);

Implements the BIP-370 Signer role.

Implementations

impl Signer

pub fn new(psbt: Psbt) -> Result<Self, DetermineLockTimeError>

Creates a Signer.

An updater can only update a PSBT that has a valid combination of lock times.

pub fn id(&self) -> Result<Txid, DetermineLockTimeError>

Returns this PSBT’s unique identification.

pub fn unsigned_tx(&self) -> Transaction

Creates an unsigned transaction from the inner Psbt.

pub fn sign<C, K>( self, k: &K, secp: &Secp256k1<C>, ) -> Result<(Psbt, SigningKeys), (SigningKeys, SigningErrors)>

where C: Signing, K: GetKey,

Attempts to create all the required signatures for this PSBT using k.

NOTE: Taproot inputs are, as yet, not supported by this function. We currently only attempt to sign ECDSA inputs.

If you just want to sign an input with one specific key consider using sighash_ecdsa. This function does not support scripts that contain OP_CODESEPARATOR.

Returns

Either Ok(SigningKeys) or Err((SigningKeys, SigningErrors)), where

• SigningKeys: A map of input index -> pubkey associated with secret key used to sign.
• SigningKeys: A map of input index -> the error encountered while attempting to sign.

If an error is returned some signatures may already have been added to the PSBT. Since partial_sigs is a BTreeMap it is safe to retry, previous sigs will be overwritten.

pub fn ecdsa_clear_tx_modifiable(&mut self, ty: EcdsaSighashType)

Sets the PSBT_GLOBAL_TX_MODIFIABLE as required after signing an ECDSA input.

For PSBTv2s, a signer must update the PSBT_GLOBAL_TX_MODIFIABLE field after signing inputs so that it accurately reflects the state of the PSBT.

pub fn psbt(self) -> Psbt

Returns the inner Psbt.

Trait Implementations

impl Clone for Signer

fn clone(&self) -> Signer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Signer

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

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 PartialEq for Signer

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Signer

impl StructuralPartialEq for Signer