-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #207: Add elip_liquidex module
7737c82 Add elip_liquidex module (Leonardo Comandini) 2ca6c7b Revert "pset: input/output: add abf" (Leonardo Comandini) Pull request description: Use "liquidex" field for the asset blinding factor. Related ELIP: ElementsProject/ELIPs#18 ACKs for top commit: RCasatta: ACK 7737c82 apoelstra: ACK 7737c82 successfully ran local tests Tree-SHA512: 4bde263a0323cc5c1198c0d024552dd53bc44b5f00572c24da773cb417e5a7020e7158dcb72f6519caff7e3dd2082c049ed9cf5394e91fba7f9a8f8eb8bbaa1a
- Loading branch information
Showing
4 changed files
with
117 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| //! | ||
| //! An implementation of ELIP0XXX as defined in | ||
| //! <https://github.com/ElementsProject/ELIPs/blob/main/elip-0XXX.mediawiki> | ||
| //! | ||
| //! ELIP0XXX defines how to encode the extra data for LiquiDEX in a PSET. | ||
| //! | ||
|
|
||
| use crate::pset::{ | ||
| confidential::AssetBlindingFactor, | ||
| encode, | ||
| raw::ProprietaryKey, | ||
| serialize::{Deserialize, Serialize}, | ||
| Input, Output, | ||
| }; | ||
|
|
||
| /// Input Asset Blinding Factor keytype as defined in ELIP0XXX | ||
| pub const PSBT_ELEMENTS_LIQUIDEX_IN_ABF: u8 = 0x00u8; | ||
|
|
||
| /// Output Asset Blinding Factor keytype as defined in ELIP0XXX | ||
| pub const PSBT_ELEMENTS_LIQUIDEX_OUT_ABF: u8 = 0x00u8; | ||
|
|
||
| /// Prefix for PSET LiquiDEX extension as defined in ELIP0XXX | ||
| pub const PSET_LIQUIDEX_PREFIX: &[u8] = b"pset_liquidex"; | ||
|
|
||
| fn prop_key(keytype: u8) -> ProprietaryKey { | ||
| ProprietaryKey { | ||
| prefix: PSET_LIQUIDEX_PREFIX.to_vec(), | ||
| subtype: keytype, | ||
| key: vec![], | ||
| } | ||
| } | ||
|
|
||
| /// ELIP0XXX LiquiDEX extensions | ||
| impl Input { | ||
| /// Set Asset Blinding Factor | ||
| pub fn set_abf(&mut self, abf: AssetBlindingFactor) { | ||
| let key = prop_key(PSBT_ELEMENTS_LIQUIDEX_IN_ABF); | ||
| self.proprietary.insert(key, abf.serialize()); | ||
| } | ||
|
|
||
| /// Get Asset Blinding Factor | ||
| pub fn get_abf(&self) -> Option<Result<AssetBlindingFactor, encode::Error>> { | ||
| let key = prop_key(PSBT_ELEMENTS_LIQUIDEX_IN_ABF); | ||
| self.proprietary | ||
| .get(&key) | ||
| .map(|data| AssetBlindingFactor::deserialize(data)) | ||
| } | ||
| } | ||
|
|
||
| /// ELIP0XXX LiquiDEX extensions | ||
| impl Output { | ||
| /// Set Asset Blinding Factor | ||
| pub fn set_abf(&mut self, abf: AssetBlindingFactor) { | ||
| let key = prop_key(PSBT_ELEMENTS_LIQUIDEX_OUT_ABF); | ||
| self.proprietary.insert(key, abf.serialize()); | ||
| } | ||
|
|
||
| /// Get Asset Blinding Factor | ||
| pub fn get_abf(&self) -> Option<Result<AssetBlindingFactor, encode::Error>> { | ||
| let key = prop_key(PSBT_ELEMENTS_LIQUIDEX_OUT_ABF); | ||
| self.proprietary | ||
| .get(&key) | ||
| .map(|data| AssetBlindingFactor::deserialize(data)) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
| use crate::encode::{serialize_hex, Encodable}; | ||
| use crate::hex::{FromHex, ToHex}; | ||
|
|
||
| // b'\xfc\rpset_liquidex' | ||
| const ELIP0XXX_IDENTIFIER: &str = "fc0d707365745f6c69717569646578"; | ||
|
|
||
| #[test] | ||
| fn prop_key_serialize() { | ||
| let key = prop_key(PSBT_ELEMENTS_LIQUIDEX_IN_ABF); | ||
| let mut vec = vec![]; | ||
| key.consensus_encode(&mut vec).unwrap(); | ||
|
|
||
| assert_eq!( | ||
| vec.to_hex(), | ||
| format!("0d{}00", PSET_LIQUIDEX_PREFIX.to_hex()) | ||
| ); | ||
|
|
||
| assert!(vec.to_hex().starts_with(&ELIP0XXX_IDENTIFIER[2..])); // cut proprietary prefix "fc" | ||
| } | ||
|
|
||
| #[test] | ||
| fn set_get_abf() { | ||
| // An ABF that's different if serialized in reverse or not | ||
| let abf_hex = "3311111111111111111111111111111111111111111111111111111111111111"; | ||
| let abf_bytes = Vec::<u8>::from_hex(abf_hex).unwrap(); | ||
| let abf = AssetBlindingFactor::from_slice(&abf_bytes).unwrap(); | ||
|
|
||
| let mut input = Input::default(); | ||
| assert!(input.get_abf().is_none()); | ||
| input.set_abf(abf); | ||
| assert_eq!(input.get_abf().unwrap().unwrap(), abf); | ||
| let input_hex = serialize_hex(&input); | ||
| assert!(input_hex.contains(ELIP0XXX_IDENTIFIER)); | ||
| assert!(input_hex.contains(abf_hex)); | ||
|
|
||
| let mut output = Output::default(); | ||
| assert!(output.get_abf().is_none()); | ||
| output.set_abf(abf); | ||
| assert_eq!(output.get_abf().unwrap().unwrap(), abf); | ||
| let output_hex = serialize_hex(&output); | ||
| assert!(output_hex.contains(ELIP0XXX_IDENTIFIER)); | ||
| assert!(output_hex.contains(abf_hex)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters