Extend docstring for more types
This commit is contained in:
parent
325ea8fb7d
commit
1875c912c3
|
@ -37,8 +37,12 @@ use crate::blockdata::constants::{max_target, WITNESS_SCALE_FACTOR};
|
|||
use crate::blockdata::script;
|
||||
use crate::VarInt;
|
||||
|
||||
/// A block header, which contains all the block's information except
|
||||
/// the actual transactions
|
||||
/// Bitcoin block header.
|
||||
///
|
||||
/// Contains all the block's information except the actual transactions, but
|
||||
/// including a root of a [merkle tree] commiting to all transactions in the block.
|
||||
///
|
||||
/// [merkle tree]: https://en.wikipedia.org/wiki/Merkle_tree
|
||||
///
|
||||
/// ### Bitcoin Core References
|
||||
///
|
||||
|
@ -164,8 +168,17 @@ impl BlockHeader {
|
|||
}
|
||||
}
|
||||
|
||||
/// A Bitcoin block, which is a collection of transactions with an attached
|
||||
/// proof of work.
|
||||
/// Bitcoin block.
|
||||
///
|
||||
/// A collection of transactions with an attached proof of work.
|
||||
///
|
||||
/// See [Bitcoin Wiki: Block][wiki-block] for more information.
|
||||
///
|
||||
/// [wiki-block]: https://en.bitcoin.it/wiki/Block
|
||||
///
|
||||
/// ### Bitcoin Core References
|
||||
///
|
||||
/// * [CBlock definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/block.h#L62)
|
||||
#[derive(PartialEq, Eq, Clone, Debug)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
pub struct Block {
|
||||
|
|
|
@ -46,7 +46,20 @@ use crate::util::taproot::{LeafVersion, TapBranchHash, TapLeafHash};
|
|||
use secp256k1::{Secp256k1, Verification, XOnlyPublicKey};
|
||||
use crate::schnorr::{TapTweak, TweakedPublicKey, UntweakedPublicKey};
|
||||
|
||||
/// A Bitcoin script.
|
||||
/// Bitcoin script.
|
||||
///
|
||||
/// A list of instructions in a simple, [Forth]-like, stack-based programming language
|
||||
/// that Bitcoin uses.
|
||||
///
|
||||
/// [Forth]: https://en.wikipedia.org/wiki/Forth_(programming_language)
|
||||
///
|
||||
/// See [Bitcoin Wiki: Script][wiki-script] for more information.
|
||||
///
|
||||
/// [wiki-script]: https://en.bitcoin.it/wiki/Script
|
||||
///
|
||||
/// ### Bitcoin Core References
|
||||
///
|
||||
/// * [CScript definition](https://github.com/bitcoin/bitcoin/blob/d492dc1cdaabdc52b0766bf4cba4bd73178325d0/src/script/script.h#L410)
|
||||
#[derive(Clone, Default, PartialOrd, Ord, PartialEq, Eq, Hash)]
|
||||
pub struct Script(Box<[u8]>);
|
||||
|
||||
|
|
|
@ -53,6 +53,10 @@ const UINT256_ONE: [u8; 32] = [
|
|||
];
|
||||
|
||||
/// A reference to a transaction output.
|
||||
///
|
||||
/// ### Bitcoin Core References
|
||||
///
|
||||
/// * [COutPoint definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L26)
|
||||
#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
|
||||
pub struct OutPoint {
|
||||
/// The referenced transaction's txid.
|
||||
|
@ -187,7 +191,15 @@ impl ::core::str::FromStr for OutPoint {
|
|||
}
|
||||
}
|
||||
|
||||
/// A transaction input, which defines old coins to be consumed
|
||||
/// Bitcoin transaction input.
|
||||
///
|
||||
/// It contains the location of the previous transaction's output,
|
||||
/// that it spends and set of scripts that satisfy its spending
|
||||
/// conditions.
|
||||
///
|
||||
/// ### Bitcoin Core References
|
||||
///
|
||||
/// * [CTxIn definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L65)
|
||||
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
pub struct TxIn {
|
||||
|
@ -220,7 +232,17 @@ impl Default for TxIn {
|
|||
}
|
||||
}
|
||||
|
||||
/// A transaction output, which defines new coins to be created from old ones.
|
||||
/// 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](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L148)
|
||||
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
pub struct TxOut {
|
||||
|
@ -237,7 +259,19 @@ impl Default for TxOut {
|
|||
}
|
||||
}
|
||||
|
||||
/// A Bitcoin transaction, which describes an authenticated movement of coins.
|
||||
/// Bitcoin transaction.
|
||||
///
|
||||
/// An authenticated movement of coins.
|
||||
///
|
||||
/// See [Bitcoin Wiki: Transaction][wiki-transaction] for more information.
|
||||
///
|
||||
/// [wiki-transaction]: https://en.bitcoin.it/wiki/Transaction
|
||||
///
|
||||
/// ### Bitcoin Core References
|
||||
///
|
||||
/// * [CTtransaction definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L279)
|
||||
///
|
||||
/// ### Serialization notes
|
||||
///
|
||||
/// If any inputs have nonempty witnesses, the entire transaction is serialized
|
||||
/// in the post-BIP141 Segwit format which includes a list of witnesses. If all
|
||||
|
|
Loading…
Reference in New Issue