milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/bitcoin/src/consensus/mod.rs

19 lines
468 B
Rust
Raw Normal View History

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
Move network::consensus_params to consensus::params
2018-09-03 05:18:57 +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 consensus.
Move network::consensus_params to consensus::params
2018-09-03 05:18:57 +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
//! This module defines structures, functions, and traits that are needed to
Move network::consensus_params to consensus::params
2018-09-03 05:18:57 +00:00
//! conform to Bitcoin consensus.
//!
Move relevant names into consensus::encode - Move network::encodable::* to consensus::encode::* - Rename Consensus{En,De}codable to {En,De}codable (now under consensus::encode) - Move network::serialize::Error to consensus::encode::Error - Remove Raw{En,De}coder, implement {En,De}coder for T: {Write,Read} instead - Move network::serialize::Simple{En,De}coder to consensus::encode::{En,De}coder - Rename util::Error::Serialize to util::Error::Encode - Modify comments to refer to new names - Modify files to refer to new names - Expose {En,De}cod{able,er}, {de,}serialize, Params - Do not return Result for serialize{,_hex} as serializing to a Vec should never fail
2018-09-20 10:15:45 +00:00
pub mod encode;
Move network::consensus_params to consensus::params
2018-09-03 05:18:57 +00:00
pub mod params;
Move relevant names into consensus::encode - Move network::encodable::* to consensus::encode::* - Rename Consensus{En,De}codable to {En,De}codable (now under consensus::encode) - Move network::serialize::Error to consensus::encode::Error - Remove Raw{En,De}coder, implement {En,De}coder for T: {Write,Read} instead - Move network::serialize::Simple{En,De}coder to consensus::encode::{En,De}coder - Rename util::Error::Serialize to util::Error::Encode - Modify comments to refer to new names - Modify files to refer to new names - Expose {En,De}cod{able,er}, {de,}serialize, Params - Do not return Result for serialize{,_hex} as serializing to a Vec should never fail
2018-09-20 10:15:45 +00:00
rename Encoder to WriteExt and Decoder to ReadExt
2019-05-23 18:43:47 +00:00
pub use self::encode::{Encodable, Decodable, WriteExt, ReadExt};
pub use self::encode::{serialize, deserialize, deserialize_partial};
Move relevant names into consensus::encode - Move network::encodable::* to consensus::encode::* - Rename Consensus{En,De}codable to {En,De}codable (now under consensus::encode) - Move network::serialize::Error to consensus::encode::Error - Remove Raw{En,De}coder, implement {En,De}coder for T: {Write,Read} instead - Move network::serialize::Simple{En,De}coder to consensus::encode::{En,De}coder - Rename util::Error::Serialize to util::Error::Encode - Modify comments to refer to new names - Modify files to refer to new names - Expose {En,De}cod{able,er}, {de,}serialize, Params - Do not return Result for serialize{,_hex} as serializing to a Vec should never fail
2018-09-20 10:15:45 +00:00
pub use self::params::Params;
Implement consensus encoding adapter for serde In some protocols it is preferred to serialize consensus-encodable types using consensus encoding. E.g. serialize `Transaction` as hex-encoded string in Json in Bitcoin Core RPC protocol. This change provides adapter to make this easier. The adapter allows providing custom byte-to-string encoder for more exotic cases and provides a hex implementation which should be useful in majority of the cases. Should help with #765
2022-09-08 14:50:24 +00:00
#[cfg(feature = "serde")]
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
pub mod serde;