diff --git a/CHANGELOG.md b/CHANGELOG.md index c8ae53c..ecf9c65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.5.5.2] + +### Added + +- Added unction to encode a Sappling Address in Human Readable Format Using a SaplingReceiver + `encodeSaplingAddress` a zcash sapling address is returned or Nothing if the function fails +- Added decoding and encoding test + + + +## [0.5.5.1] + +### Added + +- Added unction to decode a Sappling Address in Human Readable Format + `decodeSaplingAddress` returns 43 byte array containing +- Added a new Datatype `SaplingAddress` +- Added a new FFI function `rust_wrapper_decode_sapling_address` to haskell-rust interface + +### Changed + +- `TransparentAddress` type refactored +- `TransparentReceiver` added to replace old `TransparentAddress` +- `sha256` Function moved outside of `encodeTransparentReceiver` + ## [0.5.5.0] ### Added @@ -16,7 +41,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `TransparentAddress` type refactored - `TransparentReceiver` added to replace old `TransparentAddress` - `sha256` Function moved outside of `encodeTransparentReceiver` - ## [0.5.4.1] ### Added diff --git a/librustzcash-wrapper/src/lib.rs b/librustzcash-wrapper/src/lib.rs index 4806512..5b71bc6 100644 --- a/librustzcash-wrapper/src/lib.rs +++ b/librustzcash-wrapper/src/lib.rs @@ -90,6 +90,7 @@ use zcash_address::{ ZcashAddress }; +use zcash_client_backend::encoding::decode_payment_address; use zcash_client_backend::keys::sapling::{ spending_key, ExtendedFullViewingKey, @@ -1346,3 +1347,48 @@ pub extern "C" fn rust_wrapper_read_orchard_position( } } } + +pub extern "C" fn rust_wrapper_decode_sapling_address( + sapling: *const u8, + sapling_len: usize, + out: *mut u8, + out_len: &mut usize){ + let sapling_address_from_haskell : Vec = marshall_from_haskell_var(sapling, sapling_len, RW); + let sapling_address = std::str::from_utf8(&sapling_address_from_haskell).unwrap(); + + let mut netid = 0; + match sapling_address.find("1") { + Some(ix) => { + let netstr = &sapling_address[0..ix]; + if netstr == "zs" { + netid = 1 + } else { + if netstr == "ztestsapling" { + netid = 2 + } + } + match decode_payment_address(netstr, sapling_address) { + Ok( t )=> { + let address_to_bytes = t.to_bytes(); + let mut out_bytes_temp : [u8;44] = [0;44]; + out_bytes_temp[0] = netid; + let mut iy = 1; + for ix in 0..43 { + out_bytes_temp[iy] = address_to_bytes[ix]; + iy += 1; + } + let out_bytes: Vec = out_bytes_temp.to_vec(); + marshall_to_haskell_var(&out_bytes, out, out_len, RW); + } + Err(e) => { + let h = vec![0]; + marshall_to_haskell_var(&h, out, out_len, RW); + } + } + } + None => { + let h = vec![0]; + marshall_to_haskell_var(&h, out, out_len, RW); + } + } +} diff --git a/src/C/Zcash.chs b/src/C/Zcash.chs index 8eef4ad..a4bfb9d 100644 --- a/src/C/Zcash.chs +++ b/src/C/Zcash.chs @@ -232,6 +232,13 @@ import ZcashHaskell.Types -> `()' #} +{# fun unsafe rust_wrapper_decode_sapling_address as rustWrapperDecodeSaplingAddress + { toBorshVar* `BS.ByteString'& + , getVarBuffer `Buffer (BS.ByteString)'& + } + -> `()' +#} + {# fun unsafe rust_wrapper_read_orchard_commitment_tree as rustWrapperReadOrchardCommitmentTree { toBorshVar* `BS.ByteString'& , toBorshVar* `BS.ByteString'& @@ -252,4 +259,3 @@ import ZcashHaskell.Types } -> `Word64' #} - diff --git a/src/ZcashHaskell/Sapling.hs b/src/ZcashHaskell/Sapling.hs index 52f8689..fb62a7a 100644 --- a/src/ZcashHaskell/Sapling.hs +++ b/src/ZcashHaskell/Sapling.hs @@ -22,6 +22,7 @@ import C.Zcash , rustWrapperReadSaplingCommitmentTree , rustWrapperReadSaplingPosition , rustWrapperReadSaplingWitness + , rustWrapperDecodeSaplingAddress , rustWrapperSaplingCheck , rustWrapperSaplingChgPaymentAddress , rustWrapperSaplingDecodeEsk @@ -33,31 +34,35 @@ import C.Zcash ) import Data.Aeson import qualified Data.ByteString as BS +import qualified Data.ByteString.Char8 as C +import qualified Data.Text as T import Data.HexString (HexString(..), fromText, hexString, toBytes, toText) import Data.Word import Foreign.Rust.Marshall.Variable ( withPureBorshVarBuffer , withPureBorshVarBuffer ) -import ZcashHaskell.Types - ( AccountId - , CoinType - , DecodedNote(..) - , RawData(..) - , RawTxResponse(..) - , SaplingCommitmentTree(..) - , SaplingReceiver(..) - , SaplingSpendingKey(..) - , SaplingWitness(..) - , Scope(..) - , Seed(..) - , ShieldedOutput(..) - , ToBytes(..) - , ZcashNet(..) - , decodeHexText - , getValue - ) -import ZcashHaskell.Utils (decodeBech32) +import ZcashHaskell.Types +--import ZcashHaskell.Types +-- ( AccountId +-- , CoinType +-- , DecodedNote(..) +-- , RawData(..) +-- , RawTxResponse(..) +-- , SaplingAddress(..) +-- , SaplingCommitmentTree(..) +-- , SaplingReceiver(..) +-- , SaplingSpendingKey(..) +-- , SaplingWitness(..) +-- , Scope(..) +-- , Seed(..) +-- , ShieldedOutput(..) +-- , ToBytes(..) +-- , ZcashNet(..) +-- , decodeHexText +-- , getValue +-- ) +import ZcashHaskell.Utils (decodeBech32, encodeBech32, encodeBech32m) -- | Check if given bytesting is a valid encoded shielded address isValidShieldedAddress :: BS.ByteString -> Bool @@ -205,3 +210,33 @@ getSaplingWitness tree = getSaplingNotePosition :: SaplingWitness -> Integer getSaplingNotePosition = fromIntegral . rustWrapperReadSaplingPosition . hexBytes . sapWit + +-- | Encode a SaplingReceiver into HRF text +encodeSaplingAddress :: ZcashNet -> SaplingReceiver -> Maybe T.Text +encodeSaplingAddress net sr = do + case net of + MainNet -> + Just $ encodeBech32 (C.pack sapPaymentAddressHrp) (getBytes sr) + TestNet -> + Just $ encodeBech32 (C.pack sapTestPaymentAddressHrp) (getBytes sr) + +-- | Helper to get de Nework Id from FFI response +getNetId:: [Word8] -> ZcashNet +getNetId [x] = do + case x of + 1 -> MainNet + 2 -> TestNet + +-- | decode a Sapling address +decodeSaplingAddress :: BS.ByteString -> Maybe SaplingAddress +decodeSaplingAddress sapling_address = do + if BS.length sa > 1 + then do + let sa0 = BS.unpack sa + Just $ SaplingAddress (getNetId (take 1 sa0)) + $ SaplingReceiver (BS.pack (drop 1 sa0)) + else Nothing + where + sa = + withPureBorshVarBuffer $ + rustWrapperDecodeSaplingAddress sapling_address diff --git a/src/ZcashHaskell/Types.hs b/src/ZcashHaskell/Types.hs index f0daaab..37fa1b6 100644 --- a/src/ZcashHaskell/Types.hs +++ b/src/ZcashHaskell/Types.hs @@ -477,6 +477,12 @@ newtype SaplingReceiver = instance ToBytes SaplingReceiver where getBytes (SaplingReceiver s) = s +data SaplingAddress = SaplingAddress + { + net_type :: !ZcashNet + , sa_receiver :: !SaplingReceiver + } deriving (Eq, Prelude.Show, Read) + -- | Type to represent a Sapling Shielded Spend as provided by the @getrawtransaction@ RPC method data ShieldedSpend = ShieldedSpend { sp_cv :: !HexString diff --git a/test/Spec.hs b/test/Spec.hs index b1001ff..49e985c 100644 --- a/test/Spec.hs +++ b/test/Spec.hs @@ -46,8 +46,10 @@ import Test.QuickCheck import ZcashHaskell.Keys (generateWalletSeedPhrase, getWalletSeed) import ZcashHaskell.Orchard import ZcashHaskell.Sapling - ( decodeSaplingOutput + ( decodeSaplingAddress + , decodeSaplingOutput , decodeSaplingOutputEsk + , encodeSaplingAddress , genSaplingInternalAddress , genSaplingPaymentAddress , genSaplingSpendingKey @@ -77,6 +79,7 @@ import ZcashHaskell.Types , RawTxOut(..) , RawTxResponse(..) , RawZebraTx(..) + , SaplingAddress(..) , SaplingBundle(..) , SaplingCommitmentTree(..) , SaplingReceiver(..) @@ -936,6 +939,40 @@ main = do t_rec u (ta_receiver <$> decodeTransparentAddress (E.encodeUtf8 tAdd)) `shouldBe` t_rec u + describe "Decode a Sapling Address (MainNet)" $ do + let sa = + decodeSaplingAddress + "zs1waxrpde36rlrjdwfhnvw030sn29lzwmvmeupd8x2uuqgypaafx7mqcy0ep8yf2xtg30n5424t60" + it "Try to decode a valid MainNet Sapling Address" $ do + case sa of + Nothing -> assertFailure "Failed to decode MainNet SaplingAddress" + Just s -- Sapling address decoded succesfully + -> do + let sh = encodeSaplingAddress (net_type s) (sa_receiver s) + case sh of + Nothing -> + assertFailure "Failed to encode MainNet SaplingAddress" + Just zsh -> do + print zsh + zsh `shouldBe` + "zs1waxrpde36rlrjdwfhnvw030sn29lzwmvmeupd8x2uuqgypaafx7mqcy0ep8yf2xtg30n5424t60" + describe "Decode a Sapling Address (TestNet)" $ do + let sa = + decodeSaplingAddress + "ztestsapling188csdsvhdny25am8ume03qr2026hdy03zpg5pq7jmmfxtxtct0e93p0rg80yfxvynqd4gwlwft5" + it "Try to decode a valid TestNet Sapling Address " $ do + case sa of + Nothing -> assertFailure "Failed to decode TestNet SaplingAddress" + Just s -- Sapling address decoded succesfully + -> do + let sh = encodeSaplingAddress (net_type s) (sa_receiver s) + case sh of + Nothing -> + assertFailure "Failed to encode TestNet SaplingAddress" + Just zsh -> do + print zsh + zsh `shouldBe` + "ztestsapling188csdsvhdny25am8ume03qr2026hdy03zpg5pq7jmmfxtxtct0e93p0rg80yfxvynqd4gwlwft5" describe "Decode Sapling Output with spending key" $ do let p = Phrase