Skip to content

Commit

Permalink
Refactor ledgerapi's namespace to PlutusLedgerApi.* (#4530)
Browse files Browse the repository at this point in the history
Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com>
  • Loading branch information
bezirg and bezirg committed May 26, 2022
1 parent d8d7960 commit 0a8b1ad
Show file tree
Hide file tree
Showing 34 changed files with 166 additions and 161 deletions.
8 changes: 4 additions & 4 deletions doc/plutus/tutorials/BasicPolicies.hs
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import PlutusTx
import PlutusTx.Lift
import PlutusTx.Prelude

import Plutus.V1.Ledger.Contexts
import Plutus.V1.Ledger.Crypto
import Plutus.V1.Ledger.Scripts
import Plutus.V1.Ledger.Value
import PlutusLedgerApi.V1.Contexts
import PlutusLedgerApi.V1.Crypto
import PlutusLedgerApi.V1.Scripts
import PlutusLedgerApi.V1.Value

tname :: TokenName
tname = error ()
Expand Down
8 changes: 4 additions & 4 deletions doc/plutus/tutorials/BasicValidators.hs
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ import PlutusTx
import PlutusTx.Lift
import PlutusTx.Prelude

import Plutus.V1.Ledger.Contexts
import Plutus.V1.Ledger.Crypto
import Plutus.V1.Ledger.Scripts
import Plutus.V1.Ledger.Value
import PlutusLedgerApi.V1.Contexts
import PlutusLedgerApi.V1.Crypto
import PlutusLedgerApi.V1.Scripts
import PlutusLedgerApi.V1.Value

import Data.ByteString qualified as BS
import Data.ByteString.Lazy qualified as BSL
Expand Down
2 changes: 1 addition & 1 deletion doc/plutus/tutorials/basic-minting-policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Using the script context
------------------------

Minting policies have access to the :term:`script context` as their second argument.
This will always be a value of type :hsobj:``Plutus.V1.Ledger.Contexts.ScriptContext`` encoded as ``Data``.
This will always be a value of type :hsobj:``PlutusLedgerApi.V1.Contexts.ScriptContext`` encoded as ``Data``.
Minting policies tend to be particularly interested in the ``mint`` field, since the point of a minting policy is to control which tokens are minted.

It is also important for a minting policy to look at the tokens in the ``mint`` field that are part of its own asset group.
Expand Down
2 changes: 1 addition & 1 deletion doc/plutus/tutorials/basic-validators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Using the script context
------------------------

Validators have access to the :term:`script context` as their third argument.
This will always be a value of type :hsobj:`Plutus.V1.Ledger.Contexts.ScriptContext` encoded as ``Data``.
This will always be a value of type :hsobj:`PlutusLedgerApi.V1.Contexts.ScriptContext` encoded as ``Data``.

The script context gives validators a great deal of power, because it allows them to inspect other inputs and outputs of the current transaction.
For example, here is a validator that will only accept the transaction if a particular payment is made as part of it.
Expand Down
7 changes: 4 additions & 3 deletions plutus-benchmark/validation/BenchDec.hs
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
module Main where

import PlutusLedgerApi.V1
import PlutusLedgerApi.V1.Scripts
import UntypedPlutusCore qualified as UPLC

import Codec.Serialise qualified as Serialise (serialise)
import Common
import Criterion
import Data.ByteString as BS
import Data.ByteString.Lazy as BSL
import Data.ByteString.Short (toShort)
import Plutus.V1.Ledger.Api
import Plutus.V1.Ledger.Scripts
import UntypedPlutusCore qualified as UPLC

{-|
for each data/*.flat validation script, it benchmarks
Expand Down
12 changes: 5 additions & 7 deletions plutus-benchmark/validation/BenchFull.hs
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
module Main where

import Plutus.Ledger.Test.EvaluationContext (evalCtxForTesting)
import Plutus.V1.Ledger.Api
import Plutus.V1.Ledger.Scripts

import PlutusCore.Evaluation.Machine.ExBudget
import PlutusLedgerApi.Test.EvaluationContext (evalCtxForTesting)
import PlutusLedgerApi.V1
import PlutusLedgerApi.V1.Scripts
import UntypedPlutusCore qualified as UPLC

import Codec.Serialise qualified as Serialise (serialise)
import Common
Expand All @@ -13,9 +14,6 @@ import Data.ByteString.Lazy as BSL
import Data.ByteString.Short (toShort)
import Data.Either

import PlutusCore.Evaluation.Machine.ExBudget
import UntypedPlutusCore qualified as UPLC

{-|
for each data/*.flat validation script, it benchmarks
the whole time taken from script deserialization to script execution result.
Expand Down
44 changes: 22 additions & 22 deletions plutus-ledger-api/plutus-ledger-api.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,26 @@ library
hs-source-dirs: src
default-language: Haskell2010
exposed-modules:
Plutus.V1.Ledger.Address
Plutus.V1.Ledger.Api
Plutus.V1.Ledger.Bytes
Plutus.V1.Ledger.Contexts
Plutus.V1.Ledger.Credential
Plutus.V1.Ledger.Crypto
Plutus.V1.Ledger.DCert
Plutus.V1.Ledger.Interval
Plutus.V1.Ledger.Scripts
Plutus.V1.Ledger.Tx
Plutus.V1.Ledger.Time
Plutus.V1.Ledger.Value
Plutus.V1.Ledger.EvaluationContext
PlutusLedgerApi.V1
PlutusLedgerApi.V1.Address
PlutusLedgerApi.V1.Bytes
PlutusLedgerApi.V1.Contexts
PlutusLedgerApi.V1.Credential
PlutusLedgerApi.V1.Crypto
PlutusLedgerApi.V1.DCert
PlutusLedgerApi.V1.Interval
PlutusLedgerApi.V1.Scripts
PlutusLedgerApi.V1.Tx
PlutusLedgerApi.V1.Time
PlutusLedgerApi.V1.Value
PlutusLedgerApi.V1.EvaluationContext

Plutus.V2.Ledger.Api
Plutus.V2.Ledger.Contexts
Plutus.V2.Ledger.Tx
Plutus.V2.Ledger.EvaluationContext
PlutusLedgerApi.V2
PlutusLedgerApi.V2.Contexts
PlutusLedgerApi.V2.Tx
PlutusLedgerApi.V2.EvaluationContext

Plutus.ApiCommon
PlutusLedgerApi.Common
other-modules:
Codec.CBOR.Extras
Data.Either.Extras
Expand Down Expand Up @@ -85,10 +85,10 @@ library plutus-ledger-api-testlib
visibility: public
hs-source-dirs: testlib
exposed-modules:
Plutus.Ledger.Test.Examples
Plutus.Ledger.Test.EvaluationContext
Plutus.Ledger.Test.ProtocolVersions
Plutus.Ledger.Test.Scripts
PlutusLedgerApi.Test.Examples
PlutusLedgerApi.Test.EvaluationContext
PlutusLedgerApi.Test.ProtocolVersions
PlutusLedgerApi.Test.Scripts
build-depends:
base >=4.9 && <5,
plutus-core ^>=1.0,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
{-# OPTIONS_GHC -fsimpl-tick-factor=200 #-}

-- | Common types and functions used across all the ledger API modules.
module Plutus.ApiCommon where
module PlutusLedgerApi.Common where

import PlutusCore as Plutus hiding (Version)
import PlutusCore as ScriptPlutus (Version)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{- |
The interface to Plutus V1 for the ledger.
-}
module Plutus.V1.Ledger.Api (
module PlutusLedgerApi.V1 (
-- * Scripts
SerializedScript
, Script
Expand Down Expand Up @@ -108,22 +108,23 @@ module Plutus.V1.Ledger.Api (
) where

import Data.SatInt
import Plutus.ApiCommon as Common hiding (evaluateScriptCounting, evaluateScriptRestricting, isScriptWellFormed)
import Plutus.ApiCommon qualified as Common (evaluateScriptCounting, evaluateScriptRestricting, isScriptWellFormed)
import Plutus.V1.Ledger.Address
import Plutus.V1.Ledger.Bytes
import Plutus.V1.Ledger.Contexts
import Plutus.V1.Ledger.Credential
import Plutus.V1.Ledger.Crypto
import Plutus.V1.Ledger.DCert
import Plutus.V1.Ledger.EvaluationContext
import Plutus.V1.Ledger.Interval hiding (singleton)
import Plutus.V1.Ledger.Scripts as Scripts
import Plutus.V1.Ledger.Time
import Plutus.V1.Ledger.Value
import PlutusCore.Data qualified as PLC
import PlutusCore.Evaluation.Machine.ExBudget as PLC
import PlutusCore.Evaluation.Machine.ExMemory (ExCPU (..), ExMemory (..))
import PlutusLedgerApi.Common as Common hiding (evaluateScriptCounting, evaluateScriptRestricting, isScriptWellFormed)
import PlutusLedgerApi.Common qualified as Common (evaluateScriptCounting, evaluateScriptRestricting,
isScriptWellFormed)
import PlutusLedgerApi.V1.Address
import PlutusLedgerApi.V1.Bytes
import PlutusLedgerApi.V1.Contexts
import PlutusLedgerApi.V1.Credential
import PlutusLedgerApi.V1.Crypto
import PlutusLedgerApi.V1.DCert
import PlutusLedgerApi.V1.EvaluationContext
import PlutusLedgerApi.V1.Interval hiding (singleton)
import PlutusLedgerApi.V1.Scripts as Scripts
import PlutusLedgerApi.V1.Time
import PlutusLedgerApi.V1.Value
import PlutusTx (FromData (..), ToData (..), UnsafeFromData (..), fromData, toData)
import PlutusTx.Builtins.Internal (BuiltinData (..), builtinDataToData, dataToBuiltinData)
import PlutusTx.Prelude (BuiltinByteString, fromBuiltin, toBuiltin)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{-# OPTIONS_GHC -Wno-simplifiable-class-constraints #-}
{-# OPTIONS_GHC -fno-omit-interface-pragmas #-}

module Plutus.V1.Ledger.Address (
module PlutusLedgerApi.V1.Address (
Address (..),
pubKeyHashAddress,
scriptHashAddress,
Expand All @@ -23,9 +23,9 @@ import PlutusTx.Bool qualified as PlutusTx
import PlutusTx.Eq qualified as PlutusTx
import Prettyprinter

import Plutus.V1.Ledger.Credential (Credential (..), StakingCredential)
import Plutus.V1.Ledger.Crypto
import Plutus.V1.Ledger.Scripts
import PlutusLedgerApi.V1.Credential (Credential (..), StakingCredential)
import PlutusLedgerApi.V1.Crypto
import PlutusLedgerApi.V1.Scripts

-- | Address with two kinds of credentials, normal and staking.
data Address = Address{ addressCredential :: Credential, addressStakingCredential :: Maybe StakingCredential }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{-# LANGUAGE TypeApplications #-}
{-# OPTIONS_GHC -Wno-orphans #-}

module Plutus.V1.Ledger.Bytes ( LedgerBytes (..)
module PlutusLedgerApi.V1.Bytes ( LedgerBytes (..)
, fromHex
, bytes
, fromBytes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
{-# OPTIONS_GHC -Wno-simplifiable-class-constraints #-}
{-# OPTIONS_GHC -fno-specialise #-}
{-# OPTIONS_GHC -fno-omit-interface-pragmas #-}
module Plutus.V1.Ledger.Contexts
module PlutusLedgerApi.V1.Contexts
(
-- * Pending transactions and related types
TxInfo(..)
Expand Down Expand Up @@ -52,14 +52,14 @@ import PlutusTx
import PlutusTx.Prelude
import Prettyprinter (Pretty (..), nest, viaShow, vsep, (<+>))

import Plutus.V1.Ledger.Address (Address (..), toPubKeyHash)
import Plutus.V1.Ledger.Credential (Credential (..), StakingCredential)
import Plutus.V1.Ledger.Crypto (PubKeyHash (..))
import Plutus.V1.Ledger.DCert (DCert (..))
import Plutus.V1.Ledger.Scripts
import Plutus.V1.Ledger.Time (POSIXTimeRange)
import Plutus.V1.Ledger.Tx (TxId (..), TxOut (..), TxOutRef (..))
import Plutus.V1.Ledger.Value (CurrencySymbol (..), Value)
import PlutusLedgerApi.V1.Address (Address (..), toPubKeyHash)
import PlutusLedgerApi.V1.Credential (Credential (..), StakingCredential)
import PlutusLedgerApi.V1.Crypto (PubKeyHash (..))
import PlutusLedgerApi.V1.DCert (DCert (..))
import PlutusLedgerApi.V1.Scripts
import PlutusLedgerApi.V1.Time (POSIXTimeRange)
import PlutusLedgerApi.V1.Tx (TxId (..), TxOut (..), TxOutRef (..))
import PlutusLedgerApi.V1.Value (CurrencySymbol (..), Value)
import Prelude qualified as Haskell

{- Note [Script types in pending transactions]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@
Address and staking address credentials for outputs.
-}
module Plutus.V1.Ledger.Credential(
module PlutusLedgerApi.V1.Credential(
StakingCredential(..)
, Credential(..)
) where

import Control.DeepSeq (NFData)
import GHC.Generics (Generic)
import Plutus.V1.Ledger.Crypto (PubKeyHash)
import Plutus.V1.Ledger.Scripts (ValidatorHash)
import PlutusLedgerApi.V1.Crypto (PubKeyHash)
import PlutusLedgerApi.V1.Scripts (ValidatorHash)
import PlutusTx qualified as PlutusTx
import PlutusTx.Bool qualified as PlutusTx
import PlutusTx.Eq qualified as PlutusTx
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

{-# OPTIONS_GHC -fno-omit-interface-pragmas #-}

module Plutus.V1.Ledger.Crypto(
module PlutusLedgerApi.V1.Crypto(
PubKeyHash(..)
) where

import Control.DeepSeq (NFData)
import Data.String
import GHC.Generics (Generic)
import Plutus.V1.Ledger.Bytes (LedgerBytes (..))
import PlutusLedgerApi.V1.Bytes (LedgerBytes (..))
import PlutusTx qualified
import PlutusTx.Lift (makeLift)
import PlutusTx.Prelude qualified as PlutusTx
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
Digests of certificates that are included in transactions.
-}
module Plutus.V1.Ledger.DCert(DCert(..)) where
module PlutusLedgerApi.V1.DCert(DCert(..)) where

import Control.DeepSeq (NFData)
import GHC.Generics (Generic)
import Plutus.V1.Ledger.Credential (StakingCredential)
import Plutus.V1.Ledger.Crypto (PubKeyHash)
import PlutusLedgerApi.V1.Credential (StakingCredential)
import PlutusLedgerApi.V1.Crypto (PubKeyHash)
import PlutusTx qualified as PlutusTx
import PlutusTx.Prelude qualified as P
import Prettyprinter (Pretty (..), viaShow)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{-# LANGUAGE DerivingVia #-}
{-# LANGUAGE TypeApplications #-}
module Plutus.V1.Ledger.EvaluationContext
module PlutusLedgerApi.V1.EvaluationContext
( EvaluationContext
, mkEvaluationContext
, CostModelParams
Expand All @@ -13,8 +13,8 @@ module Plutus.V1.Ledger.EvaluationContext
, ParamName -- abstract
) where

import Plutus.ApiCommon
import PlutusCore.Evaluation.Machine.CostModelInterface as Plutus
import PlutusLedgerApi.Common

import Control.Monad
import Control.Monad.Except
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
{-# OPTIONS_GHC -fno-ignore-interface-pragmas #-}

-- | A type for intervals and associated functions.
module Plutus.V1.Ledger.Interval(
module PlutusLedgerApi.V1.Interval(
Interval(..)
, UpperBound(..)
, LowerBound(..)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
{-# OPTIONS_GHC -fno-warn-name-shadowing #-}

-- | Functions for working with scripts on the ledger.
module Plutus.V1.Ledger.Scripts(
module PlutusLedgerApi.V1.Scripts(
-- * Scripts
Script (..),
scriptSize,
Expand Down Expand Up @@ -67,13 +67,13 @@ import Data.ByteString.Lazy qualified as BSL
import Data.String
import Data.Text (Text)
import GHC.Generics (Generic)
import Plutus.V1.Ledger.Bytes (LedgerBytes (..))
import PlutusCore qualified as PLC
import PlutusCore.Data qualified as PLC
import PlutusCore.Evaluation.Machine.ExBudget qualified as PLC
import PlutusCore.Evaluation.Machine.ExBudgetingDefaults qualified as PLC
import PlutusCore.Evaluation.Machine.Exception (ErrorWithCause (..), EvaluationError (..))
import PlutusCore.MkPlc qualified as PLC
import PlutusLedgerApi.V1.Bytes (LedgerBytes (..))
import PlutusTx (CompiledCode, FromData (..), ToData (..), UnsafeFromData (..), getPlc, makeLift)
import PlutusTx.Builtins as Builtins
import PlutusTx.Builtins.Internal as BI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
{-# OPTIONS_GHC -fno-omit-interface-pragmas #-}

-- | UTCTime and UTCTime ranges.
module Plutus.V1.Ledger.Time(
module PlutusLedgerApi.V1.Time(
POSIXTime(..)
, POSIXTimeRange
, DiffMilliSeconds(..)
Expand All @@ -23,7 +23,7 @@ module Plutus.V1.Ledger.Time(

import Control.DeepSeq (NFData)
import GHC.Generics (Generic)
import Plutus.V1.Ledger.Interval
import PlutusLedgerApi.V1.Interval
import PlutusTx qualified
import PlutusTx.Lift (makeLift)
import PlutusTx.Prelude
Expand Down

0 comments on commit 0a8b1ad

Please sign in to comment.