Merge pull request #690 from IntersectMBO/jj/leios-cert-constructor

Remove `LeiosCert` encoder/decoder, export `BitField` constructor

Author: Soupstraw

cardano-crypto-leios/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Changelog for `cardano-crypto-leios`
 
-## 0.1.0.2
+## 0.2.0.0
 
-*
+* Remove:
+  - `encodeLeiosCert`
+  - `decodeLeiosCert`
+  - `encodeLeiosVoterId`
+  - `decodeLeiosVoterId`
+  - `encodeBitField`
+  - `decodeBitField`
+* Export `BitField` constructor
 
 ## 0.1.0.1
 

cardano-crypto-leios/cardano-crypto-leios.cabal

@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: cardano-crypto-leios
-version: 0.1.0.1
+version: 0.2.0.0
 synopsis: Crypto primitives for Leios
 description:
   Data types for the Leios cryptographic artifacts as specified in CIP-0164.
@@ -38,10 +38,8 @@ library
 
   build-depends:
     bytestring,
-    cardano-base >=0.1.6,
     cardano-binary,
     cardano-crypto-class >=2.5.1,
-    cborg,
     containers,
     deepseq,
     nothunks,
@@ -74,16 +72,12 @@ test-suite tests
 
   build-depends:
     QuickCheck,
-    base16-bytestring,
     bytestring,
     cardano-base:testlib,
-    cardano-binary >=1.9.1,
     cardano-crypto-class >=2.5.1,
-    cardano-crypto-leios:{cardano-crypto-leios, testlib},
-    cborg,
+    cardano-crypto-leios,
     containers,
     hspec,
-    hspec-golden,
     vector,
 
   ghc-options:

cardano-crypto-leios/src/Cardano/Crypto/Leios.hs

@@ -27,8 +27,6 @@ module Cardano.Crypto.Leios (
   -- * Voting committee
   Weight,
   LeiosVoterId (..),
-  encodeLeiosVoterId,
-  decodeLeiosVoterId,
   LeiosVoter (..),
   LeiosCommittee (..),
   leiosCommitteeSize,
@@ -37,8 +35,6 @@ module Cardano.Crypto.Leios (
 
   -- * Leios certificates
   LeiosCert (..),
-  encodeLeiosCert,
-  decodeLeiosCert,
 
   -- ** Construction
   AggregationError (..),
@@ -49,17 +45,11 @@ module Cardano.Crypto.Leios (
   verifyLeiosCert,
 
   -- * Bitfield wire-format helpers
-  BitField,
-  encodeBitField,
-  decodeBitField,
+  BitField (..),
 ) where
 
-import Cardano.Base.Bytes (byteArrayFromByteString)
-import Cardano.Binary (matchSize, toCBOR)
 import Cardano.Binary.FixedSizeCodec (
   FixedSizeCodec (..),
-  decodeFixedSized,
-  encodeFixedSized,
   fixedSize,
  )
 import Cardano.Crypto.DSIGN (
@@ -71,10 +61,8 @@ import Cardano.Crypto.DSIGN (
  )
 import Cardano.Crypto.DSIGN.BLS12381 (BLS12381MinSigDSIGN, BLS12381SignContext, minSigPoPDST)
 import Cardano.Crypto.Util (SignableRepresentation)
-import Codec.CBOR.Decoding (Decoder, decodeBreakOr, decodeBytes, decodeListLenOrIndef, decodeWord16)
-import Codec.CBOR.Encoding (Encoding, encodeListLen, encodeWord16)
 import Control.DeepSeq (NFData)
-import Control.Monad (forM_, unless, when)
+import Control.Monad (forM_, when)
 import Data.Array.Byte (ByteArray)
 import Data.Bifunctor (first)
 import Data.Bits (setBit, shiftR, testBit, (.&.))
@@ -138,14 +126,6 @@ newtype LeiosVoterId = LeiosVoterId {leiosVoterIndex :: Word16}
   deriving stock (Eq, Ord, Show, Generic)
   deriving newtype (NFData, NoThunks)
 
--- | Plain CBOR encoder for 'LeiosVoterId'.
-encodeLeiosVoterId :: LeiosVoterId -> Encoding
-encodeLeiosVoterId (LeiosVoterId idx) = encodeWord16 idx
-
--- | Plain CBOR decoder for 'LeiosVoterId'.
-decodeLeiosVoterId :: Decoder s LeiosVoterId
-decodeLeiosVoterId = LeiosVoterId <$> decodeWord16
-
 -- | A single seat in a 'LeiosCommittee': a voter's normalised weight paired with
 -- its BLS verification key.
 data LeiosVoter = LeiosVoter
@@ -239,32 +219,6 @@ data LeiosCert = LeiosCert
   deriving stock (Show, Eq, Generic)
   deriving anyclass (NFData, NoThunks)
 
--- | Plain CBOR encoder for 'LeiosCert', matching the CDDL in 'LeiosCert'.
-encodeLeiosCert :: LeiosCert -> Encoding
-encodeLeiosCert cert =
-  encodeListLen 2
-    <> encodeBitField cert.leiosCertSigners
-    <> encodeFixedSized cert.leiosCertSignature
-
--- | Plain CBOR decoder for 'LeiosCert', matching the CDDL in 'LeiosCert'.
--- Accepts both definite-length and indefinite-length encodings of the
--- outer 2-element array.
-decodeLeiosCert :: Decoder s LeiosCert
-decodeLeiosCert = do
-  isIndef <-
-    decodeListLenOrIndef >>= \case
-      Just n -> False <$ matchSize "LeiosCert" 2 n
-      Nothing -> pure True
-  cert <-
-    LeiosCert
-      <$> decodeBitField
-      <*> decodeFixedSized
-  when isIndef $ do
-    isBreak <- decodeBreakOr
-    unless isBreak $
-      fail "LeiosCert: expected break after 2 elements of indefinite-length list"
-  pure cert
-
 data AggregationError
   = -- | One or more voter indices in the sigs are past the committee bound.
     VoterIdsOutOfBounds (NonEmpty LeiosVoterId)
@@ -411,11 +365,3 @@ newtype BitField = BitField {bitFieldBytes :: ByteArray}
   deriving stock (Show, Eq, Generic)
   deriving newtype (NFData)
   deriving (NoThunks) via OnlyCheckWhnfNamed "BitField" BitField
-
--- | Encode a 'BitField' to CBOR bytes.
-encodeBitField :: BitField -> Encoding
-encodeBitField = toCBOR . bitFieldBytes
-
--- | Decode a 'BitField' from CBOR bytes.
-decodeBitField :: Decoder s BitField
-decodeBitField = BitField . byteArrayFromByteString <$> decodeBytes

cardano-crypto-leios/test/Test/Cardano/Crypto/Leios.hs

@@ -5,8 +5,6 @@
 
 module Test.Cardano.Crypto.Leios (spec, exampleCert) where
 
-import qualified Cardano.Binary as CBOR
-import Cardano.Binary.FixedSizeCodec (encodeFixedSized)
 import Cardano.Crypto.DSIGN (
   DSIGNAlgorithm (deriveVerKeyDSIGN),
   genKeyDSIGN,
@@ -25,22 +23,13 @@ import Cardano.Crypto.Leios (
   VerificationError (..),
   Weight,
   aggregateLeiosCert,
-  decodeLeiosCert,
-  decodeLeiosVoterId,
-  encodeBitField,
-  encodeLeiosCert,
-  encodeLeiosVoterId,
   getLeiosVoterId,
   leiosSignContext,
   resolveLeiosVoter,
   verifyLeiosCert,
  )
 import Cardano.Crypto.Seed (mkSeedFromBytes)
-import Codec.CBOR.Encoding (Encoding, encodeBreak, encodeListLenIndef)
 import qualified Data.ByteString as BS
-import qualified Data.ByteString.Base16 as BS16
-import qualified Data.ByteString.Char8 as BS8
-import qualified Data.ByteString.Lazy as BSL
 import Data.Foldable (toList)
 import Data.List.NonEmpty (NonEmpty (..), fromList)
 import Data.Map.Strict (Map)
@@ -49,9 +38,7 @@ import Data.Proxy (Proxy (Proxy))
 import qualified Data.Vector.Strict as V
 import Data.Word (Word16, Word8)
 import Test.Cardano.Base.Bytes (genByteString)
-import Test.Cardano.Crypto.Leios.Gen (genLeiosCert)
-import Test.Hspec (Spec, context, describe, it)
-import Test.Hspec.Golden (Golden (..))
+import Test.Hspec (Spec, context, describe)
 import Test.Hspec.QuickCheck (prop)
 import Test.QuickCheck (
   Property,
@@ -65,11 +52,6 @@ import qualified Test.QuickCheck as QC
 spec :: Spec
 spec = do
   describe "LeiosCert" $ do
-    prop "round-trips through CBOR" prop_roundtrip_LeiosCert
-    prop "decodes indefinite-length encoding" prop_decode_indefinite_LeiosCert
-    it "matches golden encoding" $
-      goldenEncoding "test/golden/LeiosCert" encodeLeiosCert exampleCert
-
     describe "aggregateLeiosCert" $ do
       prop "rejects an out-of-range LeiosVoterId" prop_aggregateLeiosCert_rejects_out_of_range
       prop "rejects empty contributions" prop_aggregateLeiosCert_rejects_empty
@@ -84,52 +66,12 @@ spec = do
         prop "rejects a bitfield wider than the committee" prop_verifyLeiosCert_rejects_oversized_signers
         prop "rejects a tampered bitfield" prop_verifyLeiosCert_rejects_tampered_bitfield
 
-  describe "LeiosVoterId" $ do
-    prop "round-trips through CBOR" prop_roundtrip_VoterId
-    it "matches golden encoding" $
-      goldenEncoding "test/golden/LeiosVoterId" encodeLeiosVoterId exampleVoterId
-
   describe "LeiosCommittee" $ do
     prop
       "getLeiosVoterId and resolveLeiosVoter agree on verification keys"
       prop_resolveVoter_getVoterId_inverse
     prop "getLeiosVoterId returns the first matching index" prop_getVoterId_returns_first_index
 
--- * CBOR roundtrip / golden
-
-prop_roundtrip_LeiosCert :: Property
-prop_roundtrip_LeiosCert = forAll genLeiosCert $ \cert ->
-  let bs = CBOR.serialize (encodeLeiosCert cert)
-   in CBOR.decodeFullDecoder "LeiosCert" decodeLeiosCert bs === Right cert
-
--- | The decoder must accept indefinite-length encodings of the outer
--- 2-element array, not just the canonical definite-length form.
-prop_decode_indefinite_LeiosCert :: Property
-prop_decode_indefinite_LeiosCert = forAll genLeiosCert $ \cert ->
-  let indef =
-        encodeListLenIndef
-          <> encodeBitField (leiosCertSigners cert)
-          <> encodeFixedSized (leiosCertSignature cert)
-          <> encodeBreak
-   in CBOR.decodeFullDecoder "LeiosCert" decodeLeiosCert (CBOR.serialize indef)
-        === Right cert
-
--- | Pin the byte-for-byte CBOR encoding of a value to a golden file using
--- 'hspec-golden'. Failure diffs are rendered as base16 hex. Decode
--- round-trip of arbitrary values is covered by the matching @roundtrip_@
--- property; this only locks the encoding shape.
-goldenEncoding :: FilePath -> (a -> Encoding) -> a -> Golden BSL.ByteString
-goldenEncoding path enc value =
-  Golden
-    { output = CBOR.serialize (enc value)
-    , encodePretty = BS8.unpack . BS16.encode . BSL.toStrict
-    , writeToFile = BSL.writeFile
-    , readFromFile = BSL.readFile
-    , goldenFile = path
-    , actualFile = Nothing
-    , failFirstTime = False
-    }
-
 exampleCert :: LeiosCert
 exampleCert = case aggregateLeiosCert committee contributions of
   Right c -> c
@@ -139,15 +81,7 @@ exampleCert = case aggregateLeiosCert committee contributions of
     msg = "leios-golden-message" :: BS.ByteString
     contributions = signContribs msg (zip [0 ..] (toList sks))
 
--- * LeiosVoterId CBOR / committee lookup
-
-prop_roundtrip_VoterId :: Property
-prop_roundtrip_VoterId = forAll (LeiosVoterId <$> QC.arbitrary) $ \vid ->
-  let bs = CBOR.serialize (encodeLeiosVoterId vid)
-   in CBOR.decodeFullDecoder "LeiosVoterId" decodeLeiosVoterId bs === Right vid
-
-exampleVoterId :: LeiosVoterId
-exampleVoterId = LeiosVoterId 0xABCD
+-- * LeiosVoterId committee lookup
 
 -- | 'getLeiosVoterId' and 'resolveLeiosVoter' are mutual inverses on the verification
 -- key projection: for any voter in the committee, looking up its 'LeiosVoterId'