Struct Global 

pub struct Global { /* private fields */ }

Global fields that are relevant to the transaction as a whole.

Implementations

impl Global

pub fn tx_version(&self) -> &u32

pub fn version_group_id(&self) -> &u32

pub fn consensus_branch_id(&self) -> &u32

The consensus branch ID for the chain in which this transaction will be mined.

Non-optional because this commits to the set of consensus rules that will apply to the transaction; differences therein can affect every role.

pub fn fallback_lock_time(&self) -> &Option<u32>

The transaction locktime to use if no inputs specify a required locktime.

• This is set by the Creator.
• If omitted, the fallback locktime is assumed to be 0.

The transaction’s actual lock time is given by determine_lock_time, which takes the inputs’ required lock times into account.

pub fn expiry_height(&self) -> &u32

pub fn coin_type(&self) -> &u32

The SLIP 44 coin type, indicating the network for which this transaction is being constructed.

This is technically information that could be determined indirectly from the consensus_branch_id but is included explicitly to enable easy identification. Note that this field is not included in the transaction and has no consensus effect (consensus_branch_id fills that role).

• This is set by the Creator.
• Roles that encode network-specific information (for example, derivation paths for key identification) should check against this field for correctness.

pub fn tx_modifiable(&self) -> &u8

A bitfield for various transaction modification flags.

• Bit 0 is the Transparent Inputs Modifiable Flag and indicates whether transparent inputs can be modified.
  • This is set to true by the Creator.
  • This is checked by the Constructor before adding transparent inputs, and may be set to false by the Constructor.
  • This is set to false by the IO Finalizer if there are shielded spends or outputs.
  • This is set to false by a Signer that adds a signature that does not use SIGHASH_ANYONECANPAY (which includes all shielded signatures).
  • The Combiner merges this bit towards false.
• Bit 1 is the Transparent Outputs Modifiable Flag and indicates whether transparent outputs can be modified.
  • This is set to true by the Creator.
  • This is checked by the Constructor before adding transparent outputs, and may be set to false by the Constructor.
  • This is set to false by the IO Finalizer if there are shielded spends or outputs.
  • This is set to false by a Signer that adds a signature that does not use SIGHASH_NONE (which includes all shielded signatures).
  • The Combiner merges this bit towards false.
• Bit 2 is the Has SIGHASH_SINGLE Flag and indicates whether the transaction has a SIGHASH_SINGLE transparent signature who’s input and output pairing must be preserved.
  • This is set to false by the Creator.
  • This is updated by a Constructor.
  • This is set to true by a Signer that adds a signature that uses SIGHASH_SINGLE.
  • This essentially indicates that the Constructor must iterate the transparent inputs to determine whether and how to add a transparent input.
  • The Combiner merges this bit towards true.
• Bits 3-6 must be 0.
• Bit 7 is the Shielded Modifiable Flag and indicates whether shielded spends or outputs can be modified.
  • This is set to true by the Creator.
  • This is checked by the Constructor before adding shielded spends or outputs, and may be set to false by the Constructor.
  • This is set to false by the IO Finalizer if there are shielded spends or outputs.
  • This is set to false by every Signer (as all signatures commit to all shielded spends and outputs).
  • The Combiner merges this bit towards false.

Individual flags are also available via Global::inputs_modifiable, Global::outputs_modifiable, Global::has_sighash_single, and Global::shielded_modifiable.

pub fn proprietary(&self) -> &BTreeMap<String, Vec<u8>>

Proprietary fields related to the overall transaction.

impl Global

pub fn inputs_modifiable(&self) -> bool

Returns whether transparent inputs can be added to or removed from the transaction.

pub fn outputs_modifiable(&self) -> bool

Returns whether transparent outputs can be added to or removed from the transaction.

pub fn has_sighash_single(&self) -> bool

Returns whether the transaction has a SIGHASH_SINGLE transparent signature who’s input and output pairing must be preserved.

pub fn shielded_modifiable(&self) -> bool

Returns whether shielded spends or outputs can be added to or removed from the transaction.

Trait Implementations

impl Clone for Global

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Global

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Global

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Global

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

where __S: Serializer,

Serialize this value into the given Serde serializer.