Merge pull request 'Implement generation of Orchard receiver' (#22) from rav001 into dev040

Reviewed-on: #22

CHANGELOG.md

@@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Function to encode unified addresses from receivers
 - Function to generate an Orchard spending key
 - Constants for Zcash protocol
+- Types for Spending Keys and Receivers for Sapling and Orchard
+- Function to generate an Orchard receiver
 
 ### Changed
 

librustzcash-wrapper/src/lib.rs

@@ -632,3 +632,19 @@ pub extern "C" fn rust_wrapper_derive_orchard_spending_key(
         }
     }
 }
+
+#[no_mangle]
+pub extern "C" fn rust_wrapper_derive_orchard_receiver(
+    spend_key: *const u8,
+    spend_key_len: usize,
+    add_id: u32,
+    out: *mut u8,
+    out_len: &mut usize
+    ){
+    let sk_in: Vec<u8> = marshall_from_haskell_var(spend_key, spend_key_len, RW);
+    let sk = SpendingKey::from_bytes(sk_in[0..32].try_into().unwrap()).unwrap();
+    let fvk = FullViewingKey::from(&sk);
+    let o_rec = fvk.address_at(add_id, Scope::External);
+    marshall_to_haskell_var(&o_rec.to_raw_address_bytes().to_vec(), out, out_len, RW);
+
+}

src/C/Zcash.chs

@@ -142,3 +142,11 @@ import ZcashHaskell.Types
      }
   -> `()'
 #}
+
+{# fun unsafe rust_wrapper_derive_orchard_receiver as rustWrapperGenOrchardReceiver
+     { toBorshVar* `BS.ByteString'&
+     , `Word32'
+     , getVarBuffer `Buffer (BS.ByteString)'&
+     }
+  -> `()'
+#}

src/ZcashHaskell/Orchard.hs

@@ -18,7 +18,8 @@
 module ZcashHaskell.Orchard where
 
 import C.Zcash
-  ( rustWrapperGenOrchardSpendKey
+  ( rustWrapperGenOrchardReceiver
+  , rustWrapperGenOrchardSpendKey
   , rustWrapperOrchardCheck
   , rustWrapperOrchardNoteDecode
   , rustWrapperUADecode
@@ -34,7 +35,8 @@ import ZcashHaskell.Types
 import ZcashHaskell.Utils (encodeBech32m, f4Jumble)
 
 -- | Derives an Orchard spending key for the given seed and account ID
-genOrchardSpendingKey :: Seed -> CoinType -> AccountId -> Maybe BS.ByteString
+genOrchardSpendingKey ::
+     Seed -> CoinType -> AccountId -> Maybe OrchardSpendingKey
 genOrchardSpendingKey s coinType accountId =
   if BS.length k /= 32
     then Nothing
@@ -47,6 +49,17 @@ genOrchardSpendingKey s coinType accountId =
         (getValue coinType)
         (fromIntegral accountId)
 
+-- | Derives an Orchard receiver for the given spending key and index
+genOrchardReceiver :: Int -> OrchardSpendingKey -> Maybe OrchardReceiver
+genOrchardReceiver i osk =
+  if BS.length k /= 43
+    then Nothing
+    else Just k
+  where
+    k =
+      withPureBorshVarBuffer $
+      rustWrapperGenOrchardReceiver osk (fromIntegral i)
+
 -- | Checks if given bytestring is a valid encoded unified address
 isValidUnifiedAddress :: BS.ByteString -> Maybe UnifiedAddress
 isValidUnifiedAddress str =

src/ZcashHaskell/Types.hs

@@ -45,6 +45,18 @@ type Seed = C.ByteString
 -- | A mnemonic phrase used to derive seeds
 type Phrase = BS.ByteString
 
+-- | A spending key for Sapling
+type SaplingSpendingKey = BS.ByteString
+
+-- | A spending key for Orchard
+type OrchardSpendingKey = BS.ByteString
+
+-- | A Sapling receiver
+type SaplingReceiver = BS.ByteString
+
+-- | An Orchard receiver
+type OrchardReceiver = BS.ByteString
+
 -- | Type to represent data after Bech32 decoding
 data RawData = RawData
   { hrp :: !BS.ByteString -- ^ Human-readable part of the Bech32 encoding

zcash-haskell.cabal

@@ -5,7 +5,7 @@ cabal-version: 3.0
 -- see: https://github.com/sol/hpack
 
 name:           zcash-haskell
-version:        0.4.3.1
+version:        0.4.3.2
 synopsis:       Utilities to interact with the Zcash blockchain
 description:    Please see the README on the repo at <https://git.vergara.tech/Vergara_Tech/zcash-haskell#readme>
 category:       Blockchain