rust-bitcoin-unsafe-fast/bitcoin/src/blockdata/mod.rs

// SPDX-License-Identifier: CC0-1.0

//! Bitcoin block data.
//!
//! This module defines structures and functions for storing the blocks and
//! transactions which make up the Bitcoin system.
//!

pub mod block;
pub mod constants;
pub mod fee_rate;
pub mod locktime;
pub mod opcodes;
pub mod script;
pub mod transaction;
pub mod weight;
pub mod witness;

pub use fee_rate::FeeRate;
pub use weight::Weight;
Introduce SPDX license identifiers When `rust-bitcoin` was started in 2014 the SPDX license list and short identifiers where not a thing. Now that we have short identifiers and they are gaining popularity in other projects we can consider using them. - Add links to the SPDX website in the readme - Shorten the author section to a single line - Remove all the licence information in each file and replace it with an SPDX ID (see https://spdx.dev/ids/#how) Of note: - If the author of a file is explicitly listed, maintain this information - If the 'author' is listed as the generic 'Rust Bitcoin developers' just remove the attribution, this is implicit. This does loose the date info but that can be seen at any time from the git index using `git log --follow --format=%ad --date default <FILE> \| tail -1` 2022-06-29 04:05:31 +00:00			`// SPDX-License-Identifier: CC0-1.0`
Initial commit, move into Cargo 2014-07-18 13:56:17 +00:00
Clean up module level rustdocs Docs can always do with a bit of love. Clean up the module level (`//!`) rustdocs for all public modules. I claim uniform is better than any specific method/style. I tried to fit in with what ever was either most sane of most prevalent, therefore attaining uniformity without unnecessary code churn (one exception being the changes to headings described below). Notes: * Headings - use heading as a regular sentence for all modules e.g., ``` //! Bitcoin network messages. ``` as opposed to ``` //! # Bitcoin Network Messages ``` It was not clear which style to use so I picked a 'random' mature project and copied their style. * Added 'This module' in _most_ places as the start of the module description, however I was not religious about this one. * Fixed line length if necessary since most of our code seems to follow short (80 char) line lengths for comments anyways. * Added periods and fixed obvious (and sometimes not so obvious) grammatically errors. * Added a trailing `//!` to every block since this was almost universal already. I don't really like this one but I'm guessing it is Andrew's preferred style since its on the copyright notices as well. 2021-11-05 21:58:18 +00:00			`//! Bitcoin block data.`
Initial commit, move into Cargo 2014-07-18 13:56:17 +00:00			`//!`
Fix typos and clarify some comment in blockdata, block, address (#230) 2019-02-04 06:30:41 +00:00			`//! This module defines structures and functions for storing the blocks and`
Initial commit, move into Cargo 2014-07-18 13:56:17 +00:00			`//! transactions which make up the Bitcoin system.`
			`//!`

blockdata: Run the formatter Run `cargo +nightly fmt`, no other manual changes. 2023-02-21 23:01:26 +00:00			`pub mod block;`
Initial commit, move into Cargo 2014-07-18 13:56:17 +00:00			`pub mod constants;`
blockdata: Run the formatter Run `cargo +nightly fmt`, no other manual changes. 2023-02-21 23:01:26 +00:00			`pub mod fee_rate;`
Add lock time types Add a `LockTime` type to hold the nLockTime `u32` value. Use it in `Transaction` for `lock_time` instead of a `u32`. Make it public so this new type can be used by rust-miniscript and other downstream projects. Add a `PackedLockTime` type that wraps a raw `u32` and derives `Ord`, this type is for wrapping a consensus lock time value for nesting in types that would like to derive `Ord`. 2022-05-16 20:27:31 +00:00			`pub mod locktime;`
Initial commit, move into Cargo 2014-07-18 13:56:17 +00:00			`pub mod opcodes;`
remove script interpreter 2018-03-09 20:30:11 +00:00			`pub mod script;`
Initial commit, move into Cargo 2014-07-18 13:56:17 +00:00			`pub mod transaction;`
Add `Weight` and `FeeRate` newtypes Use of general-purpose integers is often error-prone and annoying. We're working towards improving it by introducing newtypes. This adds newtypes for weight and fee rate to make fee computation easier and more readable. Note however that this dosn't change the type for individual parts of the transaction since computing the total weight is not as simple as summing them up and we want to avoid such confusion. Part of #630 2023-02-06 20:01:48 +00:00			`pub mod weight;`
blockdata: Run the formatter Run `cargo +nightly fmt`, no other manual changes. 2023-02-21 23:01:26 +00:00			`pub mod witness;`
Add `Weight` and `FeeRate` newtypes Use of general-purpose integers is often error-prone and annoying. We're working towards improving it by introducing newtypes. This adds newtypes for weight and fee rate to make fee computation easier and more readable. Note however that this dosn't change the type for individual parts of the transaction since computing the total weight is not as simple as summing them up and we want to avoid such confusion. Part of #630 2023-02-06 20:01:48 +00:00
			`pub use fee_rate::FeeRate;`
blockdata: Run the formatter Run `cargo +nightly fmt`, no other manual changes. 2023-02-21 23:01:26 +00:00			`pub use weight::Weight;`