Skip to content

Commit

Permalink
MetaData -> Metadata
Browse files Browse the repository at this point in the history
git ls-files -z | xargs -0 sed -i -e 's/MetaData/Metadata/g' -e 's/MetaDatum/Metadatum/g'
  • Loading branch information
rvl committed Dec 3, 2020
1 parent 3bfead4 commit d7728e2
Show file tree
Hide file tree
Showing 17 changed files with 123 additions and 123 deletions.
2 changes: 1 addition & 1 deletion cardano-api/cardano-api.cabal
Expand Up @@ -171,7 +171,7 @@ test-suite cardano-api-test
Test.Cardano.Api.Gen
Test.Cardano.Api.Genesis
Test.Cardano.Api.Ledger
Test.Cardano.Api.MetaData
Test.Cardano.Api.Metadata
Test.Cardano.Api.Typed.Bech32
Test.Cardano.Api.Typed.CBOR
Test.Cardano.Api.Typed.Envelope
Expand Down
16 changes: 8 additions & 8 deletions cardano-api/src/Cardano/Api/Certificate.hs
Expand Up @@ -312,7 +312,7 @@ toShelleyPoolParams StakePoolParameters {
[ kh | StakeKeyHash kh <- stakePoolOwners ]
, Shelley._poolRelays = Seq.fromList
(map toShelleyStakePoolRelay stakePoolRelays)
, Shelley._poolMD = toShelleyPoolMetaData <$>
, Shelley._poolMD = toShelleyPoolMetadata <$>
maybeToStrictMaybe stakePoolMetadata
}
where
Expand All @@ -332,12 +332,12 @@ toShelleyPoolParams StakePoolParameters {
Shelley.MultiHostName
(toShelleyDnsName dnsname)

toShelleyPoolMetaData :: StakePoolMetadataReference -> Shelley.PoolMetaData
toShelleyPoolMetaData StakePoolMetadataReference {
toShelleyPoolMetadata :: StakePoolMetadataReference -> Shelley.PoolMetadata
toShelleyPoolMetadata StakePoolMetadataReference {
stakePoolMetadataURL
, stakePoolMetadataHash = StakePoolMetadataHash mdh
} =
Shelley.PoolMetaData {
Shelley.PoolMetadata {
Shelley._poolMDUrl = toShelleyUrl stakePoolMetadataURL
, Shelley._poolMDHash = Crypto.hashToBytes mdh
}
Expand Down Expand Up @@ -377,7 +377,7 @@ fromShelleyPoolParams
, stakePoolOwners = map StakeKeyHash (Set.toList _poolOwners)
, stakePoolRelays = map fromShelleyStakePoolRelay
(Foldable.toList _poolRelays)
, stakePoolMetadata = fromShelleyPoolMetaData <$>
, stakePoolMetadata = fromShelleyPoolMetadata <$>
strictMaybeToMaybe _poolMD
}
where
Expand All @@ -397,15 +397,15 @@ fromShelleyPoolParams
StakePoolRelayDnsSrvRecord
(fromShelleyDnsName dnsname)

fromShelleyPoolMetaData :: Shelley.PoolMetaData -> StakePoolMetadataReference
fromShelleyPoolMetaData Shelley.PoolMetaData {
fromShelleyPoolMetadata :: Shelley.PoolMetadata -> StakePoolMetadataReference
fromShelleyPoolMetadata Shelley.PoolMetadata {
Shelley._poolMDUrl
, Shelley._poolMDHash
} =
StakePoolMetadataReference {
stakePoolMetadataURL = Shelley.urlToText _poolMDUrl
, stakePoolMetadataHash = StakePoolMetadataHash
. fromMaybe (error "fromShelleyPoolMetaData: invalid hash. TODO: proper validation")
. fromMaybe (error "fromShelleyPoolMetadata: invalid hash. TODO: proper validation")
. Crypto.hashFromBytes
$ _poolMDHash
}
Expand Down
4 changes: 2 additions & 2 deletions cardano-api/src/Cardano/Api/Shelley.hs
Expand Up @@ -71,8 +71,8 @@ module Cardano.Api.Shelley

-- * Transaction metadata
-- | Embedding additional structured data within transactions.
toShelleyMetaData,
fromShelleyMetaData,
toShelleyMetadata,
fromShelleyMetadata,

-- * Protocol parameter updates
EpochNo(..),
Expand Down
16 changes: 8 additions & 8 deletions cardano-api/src/Cardano/Api/TxBody.hs
Expand Up @@ -113,7 +113,7 @@ import qualified Cardano.Ledger.Core as Ledger
import qualified Cardano.Ledger.Shelley.Constraints as Ledger
import qualified Cardano.Ledger.ShelleyMA.TxBody as Allegra
import qualified Cardano.Ledger.ShelleyMA.Metadata as Allegra
import qualified Shelley.Spec.Ledger.MetaData as Ledger (MetaDataHash, hashMetadata)
import qualified Shelley.Spec.Ledger.Metadata as Ledger (MetadataHash, hashMetadata)
import Ouroboros.Consensus.Shelley.Eras
(StandardShelley, StandardAllegra, StandardMary)
import Ouroboros.Consensus.Shelley.Protocol.Crypto (StandardCrypto)
Expand All @@ -123,7 +123,7 @@ import Shelley.Spec.Ledger.BaseTypes (StrictMaybe(..), maybeToStrictMa
import qualified Shelley.Spec.Ledger.Credential as Shelley
import qualified Shelley.Spec.Ledger.Genesis as Shelley
import qualified Shelley.Spec.Ledger.Keys as Shelley
import qualified Shelley.Spec.Ledger.MetaData as Shelley
import qualified Shelley.Spec.Ledger.Metadata as Shelley
import qualified Shelley.Spec.Ledger.Tx as Shelley
import qualified Shelley.Spec.Ledger.TxBody as Shelley
import qualified Shelley.Spec.Ledger.UTxO as Shelley
Expand Down Expand Up @@ -1121,8 +1121,8 @@ toShelleyWithdrawal withdrawals =
toShelleyAuxiliaryData :: Map Word64 TxMetadataValue
-> Ledger.Metadata StandardShelley
toShelleyAuxiliaryData m =
Shelley.MetaData
(toShelleyMetaData m)
Shelley.Metadata
(toShelleyMetadata m)

-- | In the Allegra and Mary eras the auxiliary data consists of the tx metadata
-- and the axiliary scripts.
Expand All @@ -1137,11 +1137,11 @@ toAllegraAuxiliaryData :: forall era ledgeera.
-> Ledger.Metadata ledgeera
toAllegraAuxiliaryData m ss =
Allegra.Metadata
(toShelleyMetaData m)
(toShelleyMetadata m)
(Seq.fromList (map toShelleyScript ss))

hashAuxiliaryData :: Shelley.ValidateMetadata ledgeera
=> Ledger.Metadata ledgeera -> Ledger.MetaDataHash ledgeera
=> Ledger.Metadata ledgeera -> Ledger.MetadataHash ledgeera
hashAuxiliaryData = Ledger.hashMetadata


Expand Down Expand Up @@ -1183,7 +1183,7 @@ makeShelleyTransaction :: [TxIn]
-> Maybe UpdateProposal
-> Either (TxBodyError ShelleyEra) (TxBody ShelleyEra)
makeShelleyTransaction txIns txOuts ttl fee
certs withdrawals mMetaData mUpdateProp =
certs withdrawals mMetadata mUpdateProp =
makeTransactionBody $
TxBodyContent {
txIns,
Expand All @@ -1192,7 +1192,7 @@ makeShelleyTransaction txIns txOuts ttl fee
txValidityRange = (TxValidityNoLowerBound,
TxValidityUpperBound
ValidityUpperBoundInShelleyEra ttl),
txMetadata = case mMetaData of
txMetadata = case mMetadata of
Nothing -> TxMetadataNone
Just md -> TxMetadataInEra
TxMetadataInShelleyEra md,
Expand Down
58 changes: 29 additions & 29 deletions cardano-api/src/Cardano/Api/TxMetadata.hs
Expand Up @@ -24,8 +24,8 @@ module Cardano.Api.TxMetadata (
TxMetadataJsonSchemaError (..),

-- * Internal conversion functions
toShelleyMetaData,
fromShelleyMetaData,
toShelleyMetadata,
fromShelleyMetadata,

-- * Data family instances
AsType(..)
Expand Down Expand Up @@ -62,7 +62,7 @@ import Control.Monad (guard, when)

import qualified Cardano.Binary as CBOR

import qualified Shelley.Spec.Ledger.MetaData as Shelley
import qualified Shelley.Spec.Ledger.Metadata as Shelley

import Cardano.Api.Eras
import Cardano.Api.Error
Expand Down Expand Up @@ -100,14 +100,14 @@ instance HasTypeProxy TxMetadata where
instance SerialiseAsCBOR TxMetadata where
serialiseToCBOR =
CBOR.serialize'
. Shelley.MetaData
. toShelleyMetaData
. Shelley.Metadata
. toShelleyMetadata
. (\(TxMetadata m) -> m)

deserialiseFromCBOR AsTxMetadata bs =
TxMetadata
. fromShelleyMetaData
. (\(Shelley.MetaData m) -> m)
. fromShelleyMetadata
. (\(Shelley.Metadata m) -> m)
<$> CBOR.decodeAnnotator "TxMetadata" fromCBOR (LBS.fromStrict bs)

makeTransactionMetadata :: Map Word64 TxMetadataValue -> TxMetadata
Expand All @@ -118,32 +118,32 @@ makeTransactionMetadata = TxMetadata
-- Internal conversion functions
--

toShelleyMetaData :: Map Word64 TxMetadataValue -> Map Word64 Shelley.MetaDatum
toShelleyMetaData = Map.map toShelleyMetaDatum
toShelleyMetadata :: Map Word64 TxMetadataValue -> Map Word64 Shelley.Metadatum
toShelleyMetadata = Map.map toShelleyMetadatum
where
toShelleyMetaDatum :: TxMetadataValue -> Shelley.MetaDatum
toShelleyMetaDatum (TxMetaNumber x) = Shelley.I x
toShelleyMetaDatum (TxMetaBytes x) = Shelley.B x
toShelleyMetaDatum (TxMetaText x) = Shelley.S x
toShelleyMetaDatum (TxMetaList xs) = Shelley.List
[ toShelleyMetaDatum x | x <- xs ]
toShelleyMetaDatum (TxMetaMap xs) = Shelley.Map
[ (toShelleyMetaDatum k,
toShelleyMetaDatum v)
toShelleyMetadatum :: TxMetadataValue -> Shelley.Metadatum
toShelleyMetadatum (TxMetaNumber x) = Shelley.I x
toShelleyMetadatum (TxMetaBytes x) = Shelley.B x
toShelleyMetadatum (TxMetaText x) = Shelley.S x
toShelleyMetadatum (TxMetaList xs) = Shelley.List
[ toShelleyMetadatum x | x <- xs ]
toShelleyMetadatum (TxMetaMap xs) = Shelley.Map
[ (toShelleyMetadatum k,
toShelleyMetadatum v)
| (k,v) <- xs ]

fromShelleyMetaData :: Map Word64 Shelley.MetaDatum -> Map Word64 TxMetadataValue
fromShelleyMetaData = Map.Lazy.map fromShelleyMetaDatum
fromShelleyMetadata :: Map Word64 Shelley.Metadatum -> Map Word64 TxMetadataValue
fromShelleyMetadata = Map.Lazy.map fromShelleyMetadatum
where
fromShelleyMetaDatum :: Shelley.MetaDatum -> TxMetadataValue
fromShelleyMetaDatum (Shelley.I x) = TxMetaNumber x
fromShelleyMetaDatum (Shelley.B x) = TxMetaBytes x
fromShelleyMetaDatum (Shelley.S x) = TxMetaText x
fromShelleyMetaDatum (Shelley.List xs) = TxMetaList
[ fromShelleyMetaDatum x | x <- xs ]
fromShelleyMetaDatum (Shelley.Map xs) = TxMetaMap
[ (fromShelleyMetaDatum k,
fromShelleyMetaDatum v)
fromShelleyMetadatum :: Shelley.Metadatum -> TxMetadataValue
fromShelleyMetadatum (Shelley.I x) = TxMetaNumber x
fromShelleyMetadatum (Shelley.B x) = TxMetaBytes x
fromShelleyMetadatum (Shelley.S x) = TxMetaText x
fromShelleyMetadatum (Shelley.List xs) = TxMetaList
[ fromShelleyMetadatum x | x <- xs ]
fromShelleyMetadatum (Shelley.Map xs) = TxMetaMap
[ (fromShelleyMetadatum k,
fromShelleyMetadatum v)
| (k,v) <- xs ]


Expand Down
4 changes: 2 additions & 2 deletions cardano-api/src/Cardano/Api/Typed.hs
Expand Up @@ -238,8 +238,8 @@ module Cardano.Api.Typed (
-- * Transaction metadata
-- | Embedding additional structured data within transactions.
TxMetadata(..),
toShelleyMetaData,
fromShelleyMetaData,
toShelleyMetadata,
fromShelleyMetadata,

-- ** Constructing metadata
TxMetadataValue(..),
Expand Down
26 changes: 13 additions & 13 deletions cardano-api/test/Test/Cardano/Api/Gen.hs
Expand Up @@ -4,39 +4,39 @@
{-# LANGUAGE ScopedTypeVariables #-}

module Test.Cardano.Api.Gen
( genMetaData
( genMetadata
) where


import Cardano.Prelude hiding (MetaData)
import Cardano.Prelude hiding (Metadata)

import qualified Data.Map.Strict as Map

import Shelley.Spec.Ledger.MetaData (MetaData (..), MetaDatum (..))
import Shelley.Spec.Ledger.Metadata (Metadata (..), Metadatum (..))

import Hedgehog (Gen)
import qualified Hedgehog.Gen as Gen
import qualified Hedgehog.Range as Range

genMetaData :: Gen MetaData
genMetaData = do
genMetadata :: Gen Metadata
genMetadata = do
numberOfIndicies <- Gen.integral (Range.linear 1 15)
let indexes = map (\i -> fromIntegral i :: Word64) [1..numberOfIndicies]
mDatums <- Gen.list (Range.singleton numberOfIndicies) genMetaDatum
return . MetaData . Map.fromList $ zip indexes mDatums
mDatums <- Gen.list (Range.singleton numberOfIndicies) genMetadatum
return . Metadata . Map.fromList $ zip indexes mDatums

genMetaDatum :: Gen MetaDatum
genMetaDatum = do
genMetadatum :: Gen Metadatum
genMetadatum = do
int <- Gen.list (Range.linear 1 5) (I <$> Gen.integral (Range.linear 1 100))
bytes <- Gen.list (Range.linear 1 5) (B <$> Gen.bytes (Range.linear 1 20))
str <- Gen.list (Range.linear 1 5) (S <$> Gen.text (Range.linear 1 20) Gen.alphaNum)
let mDatumList = int ++ bytes ++ str

singleMetaDatum <- Gen.element mDatumList
singleMetadatum <- Gen.element mDatumList

Gen.choice
[ return $ List mDatumList
, return $ Map [(singleMetaDatum, singleMetaDatum)]
, return $ Map [(List mDatumList, singleMetaDatum)]
, return $ Map [(singleMetaDatum, List mDatumList)]
, return $ Map [(singleMetadatum, singleMetadatum)]
, return $ Map [(List mDatumList, singleMetadatum)]
, return $ Map [(singleMetadatum, List mDatumList)]
]
4 changes: 2 additions & 2 deletions cardano-api/test/Test/Cardano/Api/MetaData.hs
@@ -1,11 +1,11 @@
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TemplateHaskell #-}
module Test.Cardano.Api.MetaData
module Test.Cardano.Api.Metadata
( tests
, genTxMetadata
) where

import Cardano.Prelude hiding (MetaData)
import Cardano.Prelude hiding (Metadata)

import Cardano.Api.Typed

Expand Down
2 changes: 1 addition & 1 deletion cardano-api/test/Test/Cardano/Api/Typed/Gen.hs
Expand Up @@ -46,7 +46,7 @@ import Hedgehog (Gen, Range)
import qualified Hedgehog.Gen as Gen
import qualified Hedgehog.Range as Range

import Test.Cardano.Api.MetaData (genTxMetadata)
import Test.Cardano.Api.Metadata (genTxMetadata)
import Test.Cardano.Chain.UTxO.Gen (genVKWitness)
import Test.Cardano.Crypto.Gen (genProtocolMagicId)

Expand Down
4 changes: 2 additions & 2 deletions cardano-api/test/cardano-api-test.hs
Expand Up @@ -6,7 +6,7 @@ import Test.Tasty (TestTree, defaultMain, testGroup)

import qualified Test.Cardano.Api.Crypto
import qualified Test.Cardano.Api.Ledger
import qualified Test.Cardano.Api.MetaData
import qualified Test.Cardano.Api.Metadata
import qualified Test.Cardano.Api.Typed.Bech32
import qualified Test.Cardano.Api.Typed.CBOR
import qualified Test.Cardano.Api.Typed.Envelope
Expand All @@ -27,7 +27,7 @@ tests =
[ Test.Cardano.Api.Typed.Value.tests
, Test.Cardano.Api.Crypto.tests
, Test.Cardano.Api.Ledger.tests
, Test.Cardano.Api.MetaData.tests
, Test.Cardano.Api.Metadata.tests
, Test.Cardano.Api.Typed.Bech32.tests
, Test.Cardano.Api.Typed.CBOR.tests
, Test.Cardano.Api.Typed.Envelope.tests
Expand Down
18 changes: 9 additions & 9 deletions cardano-cli/src/Cardano/CLI/Shelley/Commands.hs
Expand Up @@ -36,9 +36,9 @@ module Cardano.CLI.Shelley.Commands
, TxFile (..)
, VerificationKeyBase64 (..)
, GenesisKeyFile (..)
, MetaDataFile (..)
, MetadataFile (..)
, PoolId (..)
, PoolMetaDataFile (..)
, PoolMetadataFile (..)
, PrivKeyFile (..)
, BlockId (..)
, WitnessSigningData (..)
Expand Down Expand Up @@ -177,7 +177,7 @@ data TransactionCmd
TxMetadataJsonSchema
[ScriptFile]
-- ^ Auxillary scripts
[MetaDataFile]
[MetadataFile]
(Maybe UpdateProposalFile)
TxBodyFile
| TxSign TxBodyFile [WitnessSigningData] (Maybe NetworkId) TxFile
Expand Down Expand Up @@ -258,7 +258,7 @@ data PoolCmd
-- ^ Epoch in which to retire the stake pool.
OutputFile
| PoolGetId (VerificationKeyOrFile StakePoolKey) OutputFormat
| PoolMetaDataHash PoolMetaDataFile (Maybe OutputFile)
| PoolMetadataHash PoolMetadataFile (Maybe OutputFile)
deriving (Eq, Show)

renderPoolCmd :: PoolCmd -> Text
Expand All @@ -267,7 +267,7 @@ renderPoolCmd cmd =
PoolRegistrationCert {} -> "stake-pool registration-certificate"
PoolRetirementCert {} -> "stake-pool deregistration-certificate"
PoolGetId {} -> "stake-pool id"
PoolMetaDataHash {} -> "stake-pool metadata-hash"
PoolMetadataHash {} -> "stake-pool metadata-hash"

data QueryCmd =
QueryProtocolParameters AnyCardanoEra Protocol NetworkId (Maybe OutputFile)
Expand Down Expand Up @@ -376,8 +376,8 @@ newtype GenesisKeyFile
= GenesisKeyFile FilePath
deriving (Eq, Show)

data MetaDataFile = MetaDataFileJSON FilePath
| MetaDataFileCBOR FilePath
data MetadataFile = MetadataFileJSON FilePath
| MetadataFileCBOR FilePath

deriving (Eq, Show)

Expand All @@ -389,8 +389,8 @@ newtype PoolId
= PoolId String -- Probably not a String
deriving (Eq, Show)

newtype PoolMetaDataFile = PoolMetaDataFile
{ unPoolMetaDataFile :: FilePath }
newtype PoolMetadataFile = PoolMetadataFile
{ unPoolMetadataFile :: FilePath }
deriving (Eq, Show)

newtype GenesisDir
Expand Down

0 comments on commit d7728e2

Please sign in to comment.