Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAD-1906: Alonzo transactions and serialisation #2055

Merged
merged 4 commits into from
Dec 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions alonzo/impl/cardano-ledger-alonzo.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ library
Cardano.Ledger.Alonzo
Cardano.Ledger.Alonzo.Data
Cardano.Ledger.Alonzo.Scripts
Cardano.Ledger.Alonzo.Tx
Cardano.Ledger.Alonzo.TxBody
Cardano.Ledger.Alonzo.TxWitness
build-depends:
Expand All @@ -38,6 +39,13 @@ library
small-steps
hs-source-dirs:
src
ghc-options:
-Wall
-Wcompat
-Wincomplete-record-updates
-Wincomplete-uni-patterns
-Wredundant-constraints
-Wpartial-fields
default-language: Haskell2010

library test
Expand All @@ -52,6 +60,7 @@ library test
cardano-crypto-class,
cardano-ledger-alonzo,
cardano-ledger-shelley-ma,
cardano-ledger-shelley-ma-test,
cardano-slotting,
containers,
deepseq,
Expand All @@ -62,6 +71,13 @@ library test
small-steps
hs-source-dirs:
test/lib
ghc-options:
-Wall
-Wcompat
-Wincomplete-record-updates
-Wincomplete-uni-patterns
-Wredundant-constraints
-Wpartial-fields
default-language: Haskell2010

test-suite tests
Expand All @@ -86,3 +102,11 @@ test-suite tests
tasty,
-- cardano-ledger-alonzo:test
test
ghc-options:
-Wall
-Wcompat
-Wincomplete-record-updates
-Wincomplete-uni-patterns
-Wredundant-constraints
-Wpartial-fields
default-language: Haskell2010
4 changes: 3 additions & 1 deletion alonzo/impl/src/Cardano/Ledger/Alonzo/Data.hs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ import Shelley.Spec.Ledger.Hashing (HashAnnotated (..))

-- | TODO this should be isomorphic to the plutus type
data Data era = NotReallyData
deriving (Eq, Ord, Show)
deriving (Eq, Ord, Generic, Show)

instance NoThunks (Data era)

data EraIndependentData

Expand Down
4 changes: 2 additions & 2 deletions alonzo/impl/src/Cardano/Ledger/Alonzo/Scripts.hs
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

module Cardano.Ledger.Alonzo.Scripts
( Tag (..),
Script (..),
Script,
ExUnits (..),
)
where

import Cardano.Binary
import Cardano.Binary (FromCBOR (fromCBOR), ToCBOR (toCBOR))
import Cardano.Ledger.Era (Era (Crypto))
import Cardano.Ledger.ShelleyMA.Timelocks
import Data.Coders
Expand Down
184 changes: 184 additions & 0 deletions alonzo/impl/src/Cardano/Ledger/Alonzo/Tx.hs
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE DerivingVia #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE UndecidableInstances #-}

module Cardano.Ledger.Alonzo.Tx
( IsValidating (..),
Tx (Tx, body, wits, isValidating, auxiliaryData),
)
where

import Cardano.Binary (FromCBOR (..), ToCBOR (..))
import Cardano.Ledger.Alonzo.TxBody (TxBody)
import Cardano.Ledger.Alonzo.TxWitness (TxWitness)
import Cardano.Ledger.Compactible
import qualified Cardano.Ledger.Core as Core
import Cardano.Ledger.Era (Era)
import Cardano.Ledger.Val (DecodeMint, DecodeNonNegative, Val)
import Data.Coders
import Data.MemoBytes (Mem, MemoBytes (Memo), memoBytes)
import Data.Typeable (Typeable)
import GHC.Generics (Generic)
import NoThunks.Class (NoThunks)
import Shelley.Spec.Ledger.BaseTypes (StrictMaybe, maybeToStrictMaybe, strictMaybeToMaybe)

-- | Tag indicating whether non-native scripts in this transaction are expected
-- to validate. This is added by the block creator when constructing the block.
newtype IsValidating = IsValidating Bool
deriving (Eq, NoThunks, Show)

data TxRaw era = TxRaw
{ _body :: !(TxBody era),
_wits :: !(TxWitness era),
_isValidating :: !IsValidating,
_auxiliaryData :: !(StrictMaybe (Core.AuxiliaryData era))
}
deriving (Generic, Typeable)

deriving instance
( Era era,
Eq (Core.AuxiliaryData era),
Eq (Core.Script era),
Eq (Core.Value era),
Eq (CompactForm (Core.Value era))
) =>
Eq (TxRaw era)

deriving instance
( Era era,
Compactible (Core.Value era),
Show (Core.AuxiliaryData era),
Show (Core.Script era),
Show (Core.Value era),
Show (CompactForm (Core.Value era))
) =>
Show (TxRaw era)

instance
( Era era,
NoThunks (Core.AuxiliaryData era),
NoThunks (Core.Script era),
NoThunks (Core.Value era)
) =>
NoThunks (TxRaw era)

newtype Tx era = TxConstr (MemoBytes (TxRaw era))
deriving (ToCBOR)

deriving newtype instance
( Era era,
Eq (Core.AuxiliaryData era),
Eq (Core.Script era),
Eq (Core.Value era),
Eq (CompactForm (Core.Value era))
) =>
Eq (Tx era)

deriving newtype instance
( Era era,
Compactible (Core.Value era),
Show (Core.AuxiliaryData era),
Show (Core.Script era),
Show (Core.Value era),
Show (CompactForm (Core.Value era))
) =>
Show (Tx era)

deriving newtype instance
( Era era,
NoThunks (Core.AuxiliaryData era),
NoThunks (Core.Script era),
NoThunks (Core.Value era)
) =>
NoThunks (Tx era)

pattern Tx ::
(Era era, ToCBOR (Core.AuxiliaryData era)) =>
TxBody era ->
TxWitness era ->
IsValidating ->
StrictMaybe (Core.AuxiliaryData era) ->
Tx era
pattern Tx {body, wits, isValidating, auxiliaryData} <-
TxConstr
( Memo
TxRaw
{ _body = body,
_wits = wits,
_isValidating = isValidating,
_auxiliaryData = auxiliaryData
}
_
)
where
Tx b w v a = TxConstr $ memoBytes (encodeTxRaw $ TxRaw b w v a)

--------------------------------------------------------------------------------
-- Serialisation
--------------------------------------------------------------------------------

deriving newtype instance FromCBOR IsValidating

deriving newtype instance ToCBOR IsValidating

encodeTxRaw ::
(Era era, ToCBOR (Core.AuxiliaryData era)) =>
TxRaw era ->
Encode ('Closed 'Dense) (TxRaw era)
encodeTxRaw TxRaw {_body, _wits, _isValidating, _auxiliaryData} =
Rec TxRaw
!> To _body
!> To _wits
!> To _isValidating
!> E (encodeNullMaybe toCBOR . strictMaybeToMaybe) _auxiliaryData

instance
( Era era,
FromCBOR (Annotator (Core.Script era)),
FromCBOR (Annotator (Core.AuxiliaryData era)),
ToCBOR (Core.Script era),
Typeable (Core.Script era),
Typeable (Core.AuxiliaryData era),
Compactible (Core.Value era),
DecodeNonNegative (Core.Value era),
DecodeMint (Core.Value era),
Show (Core.Value era),
Val (Core.Value era)
) =>
FromCBOR (Annotator (TxRaw era))
where
fromCBOR =
decode $
Ann (RecD TxRaw)
<*! From
<*! From
<*! Ann From
<*! D
( sequence . maybeToStrictMaybe
<$> decodeNullMaybe fromCBOR
)

deriving via
Mem (TxRaw era)
instance
( Era era,
FromCBOR (Annotator (Core.Script era)),
FromCBOR (Annotator (Core.AuxiliaryData era)),
ToCBOR (Core.Script era),
Typeable (Core.Script era),
Typeable (Core.AuxiliaryData era),
Compactible (Core.Value era),
DecodeNonNegative (Core.Value era),
DecodeMint (Core.Value era),
Show (Core.Value era),
Val (Core.Value era)
) =>
FromCBOR (Annotator (Tx era))