zcash-haskell/src/ZcashHaskell/Orchard.hs

{- Copyright 2022-2024 Vergara Technologies LLC

  This file is part of Zcash-Haskell.
 
  Zcash-Haskell is free software: you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by the Free
  Software Foundation, either version 3 of the License, or (at your option) any
  later version.
 
  Zcash-Haskell is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  details.

  You should have received a copy of the GNU Lesser General Public License along with
  Zcash-Haskell. If not, see <https://www.gnu.org/licenses/>.
-}
-- |
-- Module      :  ZcashHaskell.Orchard
-- Copyright   :  2022-2024 Vergara Technologies
-- License     :  LGPL-3
--
-- Maintainer  :  rene@vergara.network
-- Stability   :  experimental
-- Portability :  unknown
--
-- Functions to interact with the Orchard shielded pool of the Zcash blockchain.
--
module ZcashHaskell.Orchard where

import C.Zcash
  ( rustWrapperIsUA
  , rustWrapperOrchardCheck
  , rustWrapperOrchardNoteDecode
  , rustWrapperUfvkDecode
  )
import qualified Data.ByteString as BS
import Foreign.Rust.Marshall.Variable
import ZcashHaskell.Types

-- | Checks if given bytestring is a valid encoded unified address
isValidUnifiedAddress :: BS.ByteString -> Bool
isValidUnifiedAddress = rustWrapperIsUA

-- | Attempts to decode the given bytestring into a Unified Full Viewing Key
decodeUfvk :: BS.ByteString -> Maybe UnifiedFullViewingKey
decodeUfvk str =
  case net decodedKey of
    0 -> Nothing
    _ -> Just decodedKey
  where
    decodedKey = (withPureBorshVarBuffer . rustWrapperUfvkDecode) str

-- | Check if the given UVK matches the UA given
matchOrchardAddress :: BS.ByteString -> BS.ByteString -> Bool
matchOrchardAddress = rustWrapperOrchardCheck

-- | Attempts to decode the given @OrchardAction@ using the given @UnifiedFullViewingKey@.
decryptOrchardAction ::
     UnifiedFullViewingKey -> OrchardAction -> Maybe DecodedNote
decryptOrchardAction key encAction =
  case a_value decodedAction of
    0 -> Nothing
    _ -> Just decodedAction
  where
    decodedAction =
      withPureBorshVarBuffer $
      rustWrapperOrchardNoteDecode (o_key key) encAction