Struct TxOut 

pub struct TxOut {
    pub value: Amount,
    pub script_pubkey: ScriptBuf,
}

Bitcoin transaction output.

Defines new coins to be created as a result of the transaction, along with spending conditions (“script”, aka “output script”), which an input spending it must satisfy.

An output that is not yet spent by an input is called Unspent Transaction Output (“UTXO”).

Bitcoin Core References

• CTxOut definition

Fields

value: Amount

The value of the output, in satoshis.

script_pubkey: ScriptBuf

The script which must be satisfied for the output to be spent.

Implementations

impl TxOut

pub const NULL: TxOut

This is used as a “null txout” in consensus signing code.

pub fn weight(&self) -> Weight

The weight of this output.

Keep in mind that when adding a TxOut to a Transaction the total weight of the transaction might increase more than TxOut::weight. This happens when the new output added causes the output length VarInt to increase its encoding length.

Panics

If output size * 4 overflows, this should never happen under normal conditions. Use Weght::from_vb_checked(self.size() as u64) if you are concerned.

pub fn size(&self) -> usize

Returns the total number of bytes that this output contributes to a transaction.

There is no difference between base size vs total size for outputs.

pub fn minimal_non_dust(script_pubkey: ScriptBuf) -> TxOut

Creates a TxOut with given script and the smallest possible value that is not dust per current Core policy.

Dust depends on the -dustrelayfee value of the Bitcoin Core node you are broadcasting to. This function uses the default value of 0.00003 BTC/kB (3 sat/vByte).

To use a custom value, use minimal_non_dust_custom.

pub fn minimal_non_dust_custom( script_pubkey: ScriptBuf, dust_relay_fee: FeeRate, ) -> TxOut

Creates a TxOut with given script and the smallest possible value that is not dust per current Core policy.

Dust depends on the -dustrelayfee value of the Bitcoin Core node you are broadcasting to. This function lets you set the fee rate used in dust calculation.

The current default value in Bitcoin Core (as of v26) is 3 sat/vByte.

To use the default Bitcoin Core value, use minimal_non_dust.

Trait Implementations

impl Clone for TxOut

fn clone(&self) -> TxOut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConvolveCommit<Commitment, TapretProof, TapretFirst> for TxOut

type Commitment = TxOut

Commitment type produced as a result of Self::convolve_commit procedure.

type CommitError = TapretKeyError

Error type that may be reported during Self::convolve_commit procedure. It may also be returned from ConvolveCommitProof::verify in case the proof data are invalid and the commitment can’t be re-created.

fn convolve_commit( &self, supplement: &TapretProof, msg: &Commitment, ) -> Result<(TxOut, TapretProof), <TxOut as ConvolveCommit<Commitment, TapretProof, TapretFirst>>::CommitError>

Takes the supplement to unparse the content of this container (self) (“convolves” these two data together) and uses them to produce a final Self::Commitment to the message msg.

impl ConvolveCommitProof<Commitment, TxOut, TapretFirst> for TapretProof

type Suppl = TapretProof

Supplement is a part of the proof data provided during commitment procedure.

fn restore_original(&self, commitment: &TxOut) -> TxOut

Restores the original source before the commitment from the supplement (the self) and commitment.

fn extract_supplement( &self, ) -> &<TapretProof as ConvolveCommitProof<Commitment, TxOut, TapretFirst>>::Suppl

Extract supplement from the proof.

fn verify( &self, msg: &Msg, commitment: &<Source as ConvolveCommit<Msg, Self, Protocol>>::Commitment, ) -> Result<(), ConvolveVerifyError>

where Self: VerifyEq,

Verifies commitment using proof (the self) against the message.

impl Debug for TxOut

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

Formats the value using the given formatter.

impl Decodable for TxOut

fn consensus_decode_from_finite_reader<R>(r: &mut R) -> Result<TxOut, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

fn consensus_decode<R>(r: &mut R) -> Result<TxOut, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

impl<'de> Deserialize<'de> for TxOut

fn deserialize<__D>( __deserializer: __D, ) -> Result<TxOut, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EmbedCommitProof<Commitment, TxOut, OpretFirst> for OpretProof

fn restore_original_container( &self, commit_container: &TxOut, ) -> Result<TxOut, EmbedVerifyError<OpretError>>

Restores original container before the commitment from the proof data and a container containing embedded commitment.

impl EmbedCommitVerify<Commitment, OpretFirst> for TxOut

type Proof = OpretProof

The proof of the commitment produced as a result of Self::embed_commit procedure. This proof is later used for verification.

type CommitError = OpretError

Error type that may be reported during Self::embed_commit procedure. It may also be returned from Self::verify (wrapped into EmbedVerifyError in case the proof data are invalid and the commitment can’t be re-created.

fn embed_commit( &mut self, msg: &Commitment, ) -> Result<<TxOut as EmbedCommitVerify<Commitment, OpretFirst>>::Proof, <TxOut as EmbedCommitVerify<Commitment, OpretFirst>>::CommitError>

Creates a commitment to a message and embeds it into the provided container (self) by mutating it and returning commitment proof.

fn verify( &self, msg: &Msg, proof: &Self::Proof, ) -> Result<(), EmbedVerifyError<Self::CommitError>>

where Self: VerifyEq, Self::Proof: VerifyEq,

Verifies commitment with commitment proof against the message.

impl Encodable for TxOut

fn consensus_encode<R>(&self, r: &mut R) -> Result<usize, Error>

where R: Write + ?Sized,

Encodes an object with a well-defined format.

impl Hash for TxOut

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 Ord for TxOut

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for TxOut

fn strict_decode(reader: &mut impl TypedRead) -> Result<TxOut, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDeserialize for TxOut

fn from_strict_serialized<const MAX: usize>( ast_data: Confined<Vec<u8>, 0, MAX>, ) -> Result<Self, DeserializeError>

fn strict_deserialize_from_file<const MAX: usize>( path: impl AsRef<Path>, ) -> Result<Self, DeserializeError>

impl StrictDumb for TxOut

fn strict_dumb() -> TxOut

impl StrictEncode for TxOut

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictSerialize for TxOut

fn strict_serialized_len<const MAX: usize>(&self) -> Result<usize, Error>

fn to_strict_serialized<const MAX: usize>( &self, ) -> Result<Confined<Vec<u8>, 0, MAX>, SerializeError>

fn strict_serialize_to_file<const MAX: usize>( &self, path: impl AsRef<Path>, ) -> Result<(), SerializeError>

impl StrictStruct for TxOut

const ALL_FIELDS: &'static [&'static str]

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for TxOut

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl Eq for TxOut

impl StrictProduct for TxOut

impl StructuralPartialEq for TxOut