Skip to content

Commit be1ec04

Browse files
committed
Add Hash256 type
Implement a new hash type that does not displat/fromstr in backwards direction. We need support for support for double hashing, but if we use upstream sha256d::Hash, our FromString/Display requirements break
1 parent beebab4 commit be1ec04

File tree

3 files changed

+96
-1
lines changed

3 files changed

+96
-1
lines changed

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ pub use crate::interpreter::Interpreter;
135135
pub use crate::miniscript::context::{BareCtx, Legacy, ScriptContext, Segwitv0, Tap};
136136
pub use crate::miniscript::decode::Terminal;
137137
pub use crate::miniscript::satisfy::{Preimage32, Satisfier};
138-
pub use crate::miniscript::Miniscript;
138+
pub use crate::miniscript::{hash256, Miniscript};
139139
use crate::prelude::*;
140140

141141
///Public key trait which can be converted to Hash type

src/miniscript/hash256.rs

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
// Miniscript
2+
// Written in 2022 by
3+
// Sanket Kanjalkar <[email protected]>
4+
//
5+
// To the extent possible under law, the author(s) have dedicated all
6+
// copyright and related and neighboring rights to this software to
7+
// the public domain worldwide. This software is distributed without
8+
// any warranty.
9+
//
10+
// You should have received a copy of the CC0 Public Domain Dedication
11+
// along with this software.
12+
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
13+
//
14+
15+
//! Hash256 type
16+
//!
17+
//! Functionality similar to `sha256d` Hash type in bitcoin, but the FromStr
18+
//! `Display` are *NOT* REVERSE.
19+
//!
20+
use core::str;
21+
22+
use bitcoin::hashes::{
23+
self, borrow_slice_impl, hex, hex_fmt_impl, index_impl, serde_impl, sha256, Hash as HashTrait,
24+
};
25+
26+
/// Output of the SHA256d hash function
27+
#[derive(Copy, Clone, PartialEq, Eq, Default, PartialOrd, Ord, Hash)]
28+
#[repr(transparent)]
29+
pub struct Hash(
30+
#[cfg_attr(
31+
feature = "schemars",
32+
schemars(schema_with = "crate::util::json_hex_string::len_32")
33+
)]
34+
[u8; 32],
35+
);
36+
37+
hex_fmt_impl!(Debug, Hash);
38+
hex_fmt_impl!(Display, Hash);
39+
hex_fmt_impl!(LowerHex, Hash);
40+
index_impl!(Hash);
41+
serde_impl!(Hash, 32);
42+
borrow_slice_impl!(Hash);
43+
44+
impl str::FromStr for Hash {
45+
type Err = hex::Error;
46+
fn from_str(s: &str) -> Result<Self, Self::Err> {
47+
hex::FromHex::from_hex(s)
48+
}
49+
}
50+
51+
impl HashTrait for Hash {
52+
type Engine = sha256::HashEngine;
53+
type Inner = [u8; 32];
54+
55+
fn engine() -> sha256::HashEngine {
56+
sha256::Hash::engine()
57+
}
58+
59+
fn from_engine(e: sha256::HashEngine) -> Hash {
60+
let sha2 = sha256::Hash::from_engine(e);
61+
let sha2d = sha256::Hash::hash(&sha2[..]);
62+
63+
let mut ret = [0; 32];
64+
ret.copy_from_slice(&sha2d[..]);
65+
Hash(ret)
66+
}
67+
68+
const LEN: usize = 32;
69+
70+
fn from_slice(sl: &[u8]) -> Result<Hash, hashes::Error> {
71+
if sl.len() != 32 {
72+
Err(hashes::Error::InvalidLength(Self::LEN, sl.len()))
73+
} else {
74+
let mut ret = [0; 32];
75+
ret.copy_from_slice(sl);
76+
Ok(Hash(ret))
77+
}
78+
}
79+
80+
/// sha256d has DISPLAY_BACKWARD as true
81+
const DISPLAY_BACKWARD: bool = false;
82+
83+
fn into_inner(self) -> Self::Inner {
84+
self.0
85+
}
86+
87+
fn as_inner(&self) -> &Self::Inner {
88+
&self.0
89+
}
90+
91+
fn from_inner(inner: Self::Inner) -> Self {
92+
Hash(inner)
93+
}
94+
}

src/miniscript/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ pub mod analyzable;
3737
pub mod astelem;
3838
pub(crate) mod context;
3939
pub mod decode;
40+
pub mod hash256;
4041
pub mod iter;
4142
pub mod lex;
4243
pub mod limits;

0 commit comments

Comments
 (0)