milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Improve Script documentation and fix typos

This commit is contained in:
Vojtěch Toman 2023-11-15 20:57:22 +01:00
parent c0de0f7bde
commit e1c4986f4a
No known key found for this signature in database
GPG Key ID: 9DF8CA8C3FD8A614
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
bitcoin/src/blockdata/script/borrowed.rs
View File

@ -220,7 +220,7 @@ impl Script {
/// ///
/// This may return `None` even when [`is_p2pk()`](Self::is_p2pk) returns true. /// This may return `None` even when [`is_p2pk()`](Self::is_p2pk) returns true.
/// This happens when the public key is invalid (e.g. the point not being on the curve). /// This happens when the public key is invalid (e.g. the point not being on the curve).
/// It also implies the script is unspendable. /// In this situation the script is unspendable.
#[inline] #[inline]
pub fn p2pk_public_key(&self) -> Option<PublicKey> { pub fn p2pk_public_key(&self) -> Option<PublicKey> {
PublicKey::from_slice(self.p2pk_pubkey_bytes()?).ok() PublicKey::from_slice(self.p2pk_pubkey_bytes()?).ok()
@ -521,12 +521,12 @@ impl Script {
InstructionIndices::from_instructions(self.instructions_minimal()) InstructionIndices::from_instructions(self.instructions_minimal())
} }
/// Writes the assembly decoding of the script to the formatter. /// Writes the human-readable assembly representation of the script to the formatter.
pub fn fmt_asm(&self, f: &mut dyn fmt::Write) -> fmt::Result { pub fn fmt_asm(&self, f: &mut dyn fmt::Write) -> fmt::Result {
bytes_to_asm_fmt(self.as_ref(), f) bytes_to_asm_fmt(self.as_ref(), f)
} }
/// Returns the assembly decoding of the script. /// Returns the human-readable assembly representation of the script.
pub fn to_asm_string(&self) -> String { pub fn to_asm_string(&self) -> String {
let mut buf = String::new(); let mut buf = String::new();
self.fmt_asm(&mut buf).unwrap(); self.fmt_asm(&mut buf).unwrap();
@ -537,7 +537,7 @@ impl Script {
/// ///
/// This is a more convenient and performant way to write `format!("{:x}", script)`. /// This is a more convenient and performant way to write `format!("{:x}", script)`.
/// For better performance you should generally prefer displaying the script but if `String` is /// For better performance you should generally prefer displaying the script but if `String` is
/// required (this is common in tests) this method is can be used. /// required (this is common in tests) this method can be used.
pub fn to_hex_string(&self) -> String { self.as_bytes().to_lower_hex_string() } pub fn to_hex_string(&self) -> String { self.as_bytes().to_lower_hex_string() }
/// Returns the first opcode of the script (if there is any). /// Returns the first opcode of the script (if there is any).