//! Abstractions for scripts used in the Lightning Network.
use bitcoin::blockdata::opcodes::all::OP_PUSHBYTES_0 as SEGWIT_V0;
-use bitcoin::blockdata::script::{Builder, Script};
+use bitcoin::blockdata::script::{Script, ScriptBuf};
use bitcoin::hashes::Hash;
use bitcoin::hash_types::{WPubkeyHash, WScriptHash};
-use bitcoin::secp256k1::key::PublicKey;
+use bitcoin::secp256k1::PublicKey;
+use bitcoin::address::WitnessProgram;
-use ln::features::InitFeatures;
-use ln::msgs::DecodeError;
-use util::ser::{Readable, Writeable, Writer};
+use crate::ln::channelmanager;
+use crate::ln::features::InitFeatures;
+use crate::ln::msgs::DecodeError;
+use crate::util::ser::{Readable, Writeable, Writer};
-use core::convert::TryFrom;
-use core::num::NonZeroU8;
-use io;
+use crate::io;
+
+#[allow(unused_imports)]
+use crate::prelude::*;
/// A script pubkey for shutting down a channel as defined by [BOLT #2].
///
-/// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
-#[derive(Clone, PartialEq)]
+/// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
+#[derive(Clone, PartialEq, Eq)]
pub struct ShutdownScript(ShutdownScriptImpl);
-/// An error occurring when converting from [`Script`] to [`ShutdownScript`].
+/// An error occurring when converting from [`ScriptBuf`] to [`ShutdownScript`].
#[derive(Clone, Debug)]
pub struct InvalidShutdownScript {
/// The script that did not meet the requirements from [BOLT #2].
///
- /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
- pub script: Script
+ /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
+ pub script: ScriptBuf
}
-#[derive(Clone, PartialEq)]
+#[derive(Clone, PartialEq, Eq)]
enum ShutdownScriptImpl {
/// [`PublicKey`] used to form a P2WPKH script pubkey. Used to support backward-compatible
/// serialization.
Legacy(PublicKey),
- /// [`Script`] adhering to a script pubkey format specified in BOLT #2.
- Bolt2(Script),
+ /// [`ScriptBuf`] adhering to a script pubkey format specified in BOLT #2.
+ Bolt2(ScriptBuf),
}
impl Writeable for ShutdownScript {
fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
self.0.write(w)
}
-
- fn serialized_length(&self) -> usize {
- self.0.serialized_length()
- }
}
impl Readable for ShutdownScript {
/// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
pub fn new_p2wpkh(pubkey_hash: &WPubkeyHash) -> Self {
- Self(ShutdownScriptImpl::Bolt2(Script::new_v0_wpkh(pubkey_hash)))
+ Self(ShutdownScriptImpl::Bolt2(ScriptBuf::new_v0_p2wpkh(pubkey_hash)))
}
/// Generates a P2WSH script pubkey from the given [`WScriptHash`].
pub fn new_p2wsh(script_hash: &WScriptHash) -> Self {
- Self(ShutdownScriptImpl::Bolt2(Script::new_v0_wsh(script_hash)))
+ Self(ShutdownScriptImpl::Bolt2(ScriptBuf::new_v0_p2wsh(script_hash)))
}
/// Generates a witness script pubkey from the given segwit version and program.
/// # Errors
///
/// This function may return an error if `program` is invalid for the segwit `version`.
- pub fn new_witness_program(version: NonZeroU8, program: &[u8]) -> Result<Self, InvalidShutdownScript> {
- let script = Builder::new()
- .push_int(version.get().into())
- .push_slice(&program)
- .into_script();
- Self::try_from(script)
+ pub fn new_witness_program(witness_program: &WitnessProgram) -> Result<Self, InvalidShutdownScript> {
+ Self::try_from(ScriptBuf::new_witness_program(witness_program))
}
- /// Converts the shutdown script into the underlying [`Script`].
- pub fn into_inner(self) -> Script {
+ /// Converts the shutdown script into the underlying [`ScriptBuf`].
+ pub fn into_inner(self) -> ScriptBuf {
self.into()
}
if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wpkh() || script.is_v0_p2wsh() {
true
} else if features.supports_shutdown_anysegwit() {
- script.is_witness_program() && script.as_bytes()[0] != SEGWIT_V0.into_u8()
+ script.is_witness_program() && script.as_bytes()[0] != SEGWIT_V0.to_u8()
} else {
false
}
// Note that this is only for our own shutdown scripts. Counterparties are still allowed to send us
// non-witness shutdown scripts which this rejects.
-impl TryFrom<Script> for ShutdownScript {
+impl TryFrom<ScriptBuf> for ShutdownScript {
type Error = InvalidShutdownScript;
- fn try_from(script: Script) -> Result<Self, Self::Error> {
- Self::try_from((script, &InitFeatures::known()))
+ fn try_from(script: ScriptBuf) -> Result<Self, Self::Error> {
+ Self::try_from((script, &channelmanager::provided_init_features(&crate::util::config::UserConfig::default())))
}
}
// Note that this is only for our own shutdown scripts. Counterparties are still allowed to send us
// non-witness shutdown scripts which this rejects.
-impl TryFrom<(Script, &InitFeatures)> for ShutdownScript {
+impl TryFrom<(ScriptBuf, &InitFeatures)> for ShutdownScript {
type Error = InvalidShutdownScript;
- fn try_from((script, features): (Script, &InitFeatures)) -> Result<Self, Self::Error> {
+ fn try_from((script, features): (ScriptBuf, &InitFeatures)) -> Result<Self, Self::Error> {
if is_bolt2_compliant(&script, features) && script.is_witness_program() {
Ok(Self(ShutdownScriptImpl::Bolt2(script)))
} else {
}
}
-impl Into<Script> for ShutdownScript {
- fn into(self) -> Script {
+impl Into<ScriptBuf> for ShutdownScript {
+ fn into(self) -> ScriptBuf {
match self.0 {
ShutdownScriptImpl::Legacy(pubkey) =>
- Script::new_v0_wpkh(&WPubkeyHash::hash(&pubkey.serialize())),
+ ScriptBuf::new_v0_p2wpkh(&WPubkeyHash::hash(&pubkey.serialize())),
ShutdownScriptImpl::Bolt2(script_pubkey) => script_pubkey,
}
}
#[cfg(test)]
mod shutdown_script_tests {
use super::ShutdownScript;
- use bitcoin::bech32::u5;
+
+ use bitcoin::address::{WitnessProgram, WitnessVersion};
use bitcoin::blockdata::opcodes;
- use bitcoin::blockdata::script::{Builder, Script};
+ use bitcoin::blockdata::script::{Builder, ScriptBuf};
use bitcoin::secp256k1::Secp256k1;
- use bitcoin::secp256k1::key::{PublicKey, SecretKey};
- use ln::features::InitFeatures;
- use core::convert::TryFrom;
- use core::num::NonZeroU8;
+ use bitcoin::secp256k1::{PublicKey, SecretKey};
+
+ use crate::ln::features::InitFeatures;
+ use crate::prelude::*;
- fn pubkey() -> bitcoin::util::ecdsa::PublicKey {
+ fn pubkey() -> bitcoin::key::PublicKey {
let secp_ctx = Secp256k1::signing_only();
let secret_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]).unwrap();
- bitcoin::util::ecdsa::PublicKey::new(PublicKey::from_secret_key(&secp_ctx, &secret_key))
+ bitcoin::key::PublicKey::new(PublicKey::from_secret_key(&secp_ctx, &secret_key))
}
- fn redeem_script() -> Script {
+ fn redeem_script() -> ScriptBuf {
let pubkey = pubkey();
Builder::new()
.push_opcode(opcodes::all::OP_PUSHNUM_2)
.into_script()
}
+ fn any_segwit_features() -> InitFeatures {
+ let mut features = InitFeatures::empty();
+ features.set_shutdown_any_segwit_optional();
+ features
+ }
+
#[test]
fn generates_p2wpkh_from_pubkey() {
let pubkey = pubkey();
let pubkey_hash = pubkey.wpubkey_hash().unwrap();
- let p2wpkh_script = Script::new_v0_wpkh(&pubkey_hash);
+ let p2wpkh_script = ScriptBuf::new_v0_p2wpkh(&pubkey_hash);
- let shutdown_script = ShutdownScript::new_p2wpkh_from_pubkey(pubkey.key);
- assert!(shutdown_script.is_compatible(&InitFeatures::known()));
- assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+ let shutdown_script = ShutdownScript::new_p2wpkh_from_pubkey(pubkey.inner);
+ assert!(shutdown_script.is_compatible(&any_segwit_features()));
+ assert!(shutdown_script.is_compatible(&InitFeatures::empty()));
assert_eq!(shutdown_script.into_inner(), p2wpkh_script);
}
#[test]
fn generates_p2wpkh_from_pubkey_hash() {
let pubkey_hash = pubkey().wpubkey_hash().unwrap();
- let p2wpkh_script = Script::new_v0_wpkh(&pubkey_hash);
+ let p2wpkh_script = ScriptBuf::new_v0_p2wpkh(&pubkey_hash);
let shutdown_script = ShutdownScript::new_p2wpkh(&pubkey_hash);
- assert!(shutdown_script.is_compatible(&InitFeatures::known()));
- assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+ assert!(shutdown_script.is_compatible(&any_segwit_features()));
+ assert!(shutdown_script.is_compatible(&InitFeatures::empty()));
assert_eq!(shutdown_script.into_inner(), p2wpkh_script);
assert!(ShutdownScript::try_from(p2wpkh_script).is_ok());
}
#[test]
fn generates_p2wsh_from_script_hash() {
let script_hash = redeem_script().wscript_hash();
- let p2wsh_script = Script::new_v0_wsh(&script_hash);
+ let p2wsh_script = ScriptBuf::new_v0_p2wsh(&script_hash);
let shutdown_script = ShutdownScript::new_p2wsh(&script_hash);
- assert!(shutdown_script.is_compatible(&InitFeatures::known()));
- assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+ assert!(shutdown_script.is_compatible(&any_segwit_features()));
+ assert!(shutdown_script.is_compatible(&InitFeatures::empty()));
assert_eq!(shutdown_script.into_inner(), p2wsh_script);
assert!(ShutdownScript::try_from(p2wsh_script).is_ok());
}
#[test]
fn generates_segwit_from_non_v0_witness_program() {
- let version = u5::try_from_u8(16).unwrap();
- let witness_program = Script::new_witness_program(version, &[0; 40]);
-
- let version = NonZeroU8::new(version.to_u8()).unwrap();
- let shutdown_script = ShutdownScript::new_witness_program(version, &[0; 40]).unwrap();
- assert!(shutdown_script.is_compatible(&InitFeatures::known()));
- assert!(!shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
- assert_eq!(shutdown_script.into_inner(), witness_program);
+ let witness_program = WitnessProgram::new(WitnessVersion::V16, &[0; 40]).unwrap();
+ let script = ScriptBuf::new_witness_program(&witness_program);
+ let shutdown_script = ShutdownScript::new_witness_program(&witness_program).unwrap();
+ assert!(shutdown_script.is_compatible(&any_segwit_features()));
+ assert!(!shutdown_script.is_compatible(&InitFeatures::empty()));
+ assert_eq!(shutdown_script.into_inner(), script);
}
#[test]
fn fails_from_unsupported_script() {
- let op_return = Script::new_op_return(&[0; 42]);
+ let op_return = ScriptBuf::new_op_return(&[0; 42]);
assert!(ShutdownScript::try_from(op_return).is_err());
}
-
- #[test]
- fn fails_from_invalid_segwit_version() {
- let version = NonZeroU8::new(17).unwrap();
- assert!(ShutdownScript::new_witness_program(version, &[0; 40]).is_err());
- }
-
- #[test]
- fn fails_from_invalid_segwit_v0_witness_program() {
- let witness_program = Script::new_witness_program(u5::try_from_u8(0).unwrap(), &[0; 2]);
- assert!(ShutdownScript::try_from(witness_program).is_err());
- }
-
- #[test]
- fn fails_from_invalid_segwit_non_v0_witness_program() {
- let version = u5::try_from_u8(16).unwrap();
- let witness_program = Script::new_witness_program(version, &[0; 42]);
- assert!(ShutdownScript::try_from(witness_program).is_err());
-
- let version = NonZeroU8::new(version.to_u8()).unwrap();
- assert!(ShutdownScript::new_witness_program(version, &[0; 42]).is_err());
- }
}
projects / rust-lightning / blobdiff