Enum TransactionAuth

pub enum TransactionAuth {
    Standard(TransactionSpendingCondition),
    Sponsored(TransactionSpendingCondition, TransactionSpendingCondition),
}

Types of transaction authorizations

Variants

Standard(TransactionSpendingCondition)

Sponsored(TransactionSpendingCondition, TransactionSpendingCondition)

Implementations

impl TransactionAuth

pub fn from_p2pkh(privk: &Secp256k1PrivateKey) -> Option<TransactionAuth>

pub fn from_p2sh( privks: &[Secp256k1PrivateKey], num_sigs: u16, ) -> Option<TransactionAuth>

pub fn from_p2wpkh(privk: &Secp256k1PrivateKey) -> Option<TransactionAuth>

pub fn from_p2wsh( privks: &[Secp256k1PrivateKey], num_sigs: u16, ) -> Option<TransactionAuth>

pub fn into_sponsored( self, sponsor_auth: TransactionAuth, ) -> Option<TransactionAuth>

merge two standard auths into a sponsored auth. build them with the above helper methods

pub fn set_sponsor( &mut self, sponsor_spending_cond: TransactionSpendingCondition, ) -> Result<(), CodecError>

Directly set the sponsor spending condition

pub fn is_standard(&self) -> bool

pub fn is_sponsored(&self) -> bool

pub fn into_initial_sighash_auth(self) -> TransactionAuth

When beginning to sign a sponsored transaction, the origin account will not commit to any information about the sponsor (only that it is sponsored). It does so by using sentinel sponsored account information.

pub fn origin(&self) -> &TransactionSpendingCondition

pub fn get_origin_nonce(&self) -> u64

pub fn set_origin_nonce(&mut self, n: u64)

pub fn sponsor(&self) -> Option<&TransactionSpendingCondition>

pub fn get_sponsor_nonce(&self) -> Option<u64>

pub fn set_sponsor_nonce(&mut self, n: u64) -> Result<(), CodecError>

pub fn set_tx_fee(&mut self, tx_fee: u64)

pub fn get_tx_fee(&self) -> u64

pub fn verify_origin(&self, initial_sighash: &Txid) -> Result<Txid, CodecError>

pub fn verify(&self, initial_sighash: &Txid) -> Result<(), CodecError>

pub fn clear(&mut self)

Clear out all transaction auth fields, nonces, and fee rates from the spending condition(s).

Trait Implementations

impl Clone for TransactionAuth

fn clone(&self) -> TransactionAuth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionAuth

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionAuth

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TransactionAuth

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StacksMessageCodec for TransactionAuth

fn consensus_serialize<W: Write>(&self, fd: &mut W) -> Result<(), CodecError>

serialize implementors should never error unless there is an underlying failure in writing to the fd

fn consensus_deserialize<R: Read>( fd: &mut R, ) -> Result<TransactionAuth, CodecError>

fn serialize_to_vec(&self) -> Vec<u8>

where Self: Sized,

Convenience for serialization to a vec. this function unwraps any underlying serialization error

impl StructuralPartialEq for TransactionAuth