Skip to content

Commit

Permalink
Rename some variables to make more sense with the type renames
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelpj committed Jun 8, 2021
1 parent 368c143 commit 19ca004
Show file tree
Hide file tree
Showing 33 changed files with 173 additions and 174 deletions.
2 changes: 1 addition & 1 deletion doc/plutus/tutorials/GameModel.hs
Expand Up @@ -300,7 +300,7 @@ wallets = [w1, w2, w3]
-- START gameTokenVal
gameTokenVal :: Value
gameTokenVal =
let sym = Scripts.monetaryPolicyHash G.scriptInstance
let sym = Scripts.monetaryPolicyHash G.typedValidator
in G.token sym "guess"
-- END gameTokenVal

Expand Down
14 changes: 7 additions & 7 deletions marlowe/src/Language/Marlowe/Client.hs
Expand Up @@ -153,7 +153,7 @@ marloweFollowContract = do
where
follow (ifrom, ito, params) = do
let client@StateMachineClient{scInstance} = mkMarloweClient params
let inst = validatorInstance scInstance
let inst = typedValidator scInstance
let address = Scripts.scriptAddress inst
AddressChangeResponse{acrTxns} <- addressChangeRequest
AddressChangeRequest
Expand All @@ -178,7 +178,7 @@ marloweFollowContract = do

updateHistoryFromTx StateMachineClient{scInstance, scChooser} params tx = do
logInfo @String $ "Updating history from tx" <> show (Ledger.eitherTx Ledger.txId Ledger.txId tx)
let inst = validatorInstance scInstance
let inst = typedValidator scInstance
let address = Scripts.scriptAddress inst
let utxo = outputsMapFromTxForAddress address tx
let states = getStates scInstance utxo
Expand Down Expand Up @@ -233,9 +233,9 @@ marlowePlutusContract = do
marloweContract = contract,
marloweState = emptyState slot }
let payValue = adaValueOf 0
let StateMachineInstance{validatorInstance} = scInstance
let StateMachineInstance{typedValidator} = scInstance
let tx = mustPayToTheScript marloweData payValue <> distributeRoleTokens
let lookups = Constraints.scriptInstanceLookups validatorInstance
let lookups = Constraints.typedValidatorLookups typedValidator
utx <- either (throwing _ConstraintResolutionError) pure (Constraints.mkTx lookups tx)
submitTxConfirmed utx
marlowePlutusContract
Expand Down Expand Up @@ -598,8 +598,8 @@ mkMarloweValidatorCode params =

type MarloweStateMachine = StateMachine MarloweData MarloweInput

scriptInstance :: MarloweParams -> Scripts.TypedValidator MarloweStateMachine
scriptInstance params = Scripts.mkTypedValidator @MarloweStateMachine
typedValidator :: MarloweParams -> Scripts.TypedValidator MarloweStateMachine
typedValidator params = Scripts.mkTypedValidator @MarloweStateMachine
(mkMarloweValidatorCode params)
$$(PlutusTx.compile [|| wrap ||])
where
Expand All @@ -610,7 +610,7 @@ mkMachineInstance :: MarloweParams -> SM.StateMachineInstance MarloweData Marlow
mkMachineInstance params =
SM.StateMachineInstance
(SM.mkStateMachine Nothing (mkMarloweStateMachineTransition params) isFinal)
(scriptInstance params)
(typedValidator params)


mkMarloweClient :: MarloweParams -> SM.StateMachineClient MarloweData MarloweInput
Expand Down
8 changes: 4 additions & 4 deletions marlowe/test/Spec/Marlowe/Marlowe.hs
Expand Up @@ -217,16 +217,16 @@ uniqueContractHash = do
{ rolesCurrency = cs
, rolePayoutValidatorHash = validatorHash (rolePayoutScript cs) }

let hash1 = scriptHash $ scriptInstance (params "11")
let hash2 = scriptHash $ scriptInstance (params "22")
let hash3 = scriptHash $ scriptInstance (params "22")
let hash1 = scriptHash $ typedValidator (params "11")
let hash2 = scriptHash $ typedValidator (params "22")
let hash3 = scriptHash $ typedValidator (params "22")
assertBool "Hashes must be different" (hash1 /= hash2)
assertBool "Hashes must be same" (hash2 == hash3)


validatorSize :: IO ()
validatorSize = do
let validator = validatorScript $ scriptInstance defaultMarloweParams
let validator = validatorScript $ typedValidator defaultMarloweParams
let vsize = BS.length $ Write.toStrictByteString (Serialise.encode validator)
assertBool ("Validator is too large " <> show vsize) (vsize < 1100000)

Expand Down
12 changes: 6 additions & 6 deletions plutus-benchmark/flat/Dataset.hs
Expand Up @@ -97,19 +97,19 @@ runQuote tm = do

contractsWithNames :: [ (Text, Term Name DefaultUni DefaultFun ()) ]
contractsWithNames = map (second (runQuote . nameDeBruijn . getTerm . Plutus.unScript . Plutus.unValidatorScript))
[ ("game-names", Plutus.validatorScript GameStateMachine.scriptInstance)
[ ("game-names", Plutus.validatorScript GameStateMachine.typedValidator)
, ("crowdfunding-names", Crowdfunding.contributionScript Crowdfunding.theCampaign)
, ("marlowe-names", Plutus.validatorScript $ Marlowe.scriptInstance Marlowe.defaultMarloweParams)
, ("marlowe-names", Plutus.validatorScript $ Marlowe.typedValidator Marlowe.defaultMarloweParams)
, ("vesting-names", Vesting.vestingScript vesting)
, ("escrow-names", Plutus.validatorScript $ Escrow.scriptInstance escrowParams)
, ("escrow-names", Plutus.validatorScript $ Escrow.typedValidator escrowParams)
, ("future-names", Future.validator theFuture Future.testAccounts) ]

contractsWithIndices ::
[ (Text, Term DeBruijn DefaultUni DefaultFun ()) ]
contractsWithIndices = map (second (getTerm . Plutus.unScript . Plutus.unValidatorScript))
[ ("game-indices", Plutus.validatorScript GameStateMachine.scriptInstance)
[ ("game-indices", Plutus.validatorScript GameStateMachine.typedValidator)
, ("crowdfunding-indices", Crowdfunding.contributionScript Crowdfunding.theCampaign)
, ("marlowe-indices", Plutus.validatorScript $ Marlowe.scriptInstance Marlowe.defaultMarloweParams)
, ("marlowe-indices", Plutus.validatorScript $ Marlowe.typedValidator Marlowe.defaultMarloweParams)
, ("vesting-indices", Vesting.vestingScript vesting)
, ("escrow-indices", Plutus.validatorScript $ Escrow.scriptInstance escrowParams)
, ("escrow-indices", Plutus.validatorScript $ Escrow.typedValidator escrowParams)
, ("future-indices", Future.validator theFuture Future.testAccounts) ]
4 changes: 2 additions & 2 deletions plutus-contract/src/Plutus/Contract/Effects/WriteTx.hs
Expand Up @@ -93,7 +93,7 @@ submitTxConstraints
=> TypedValidator a
-> TxConstraints (RedeemerType a) (DatumType a)
-> Contract w s e Tx
submitTxConstraints inst = submitTxConstraintsWith (Constraints.scriptInstanceLookups inst)
submitTxConstraints inst = submitTxConstraintsWith (Constraints.typedValidatorLookups inst)

-- | Build a transaction that satisfies the constraints using the UTXO map
-- to resolve any input constraints (see 'Ledger.Constraints.TxConstraints.InputConstraint')
Expand All @@ -109,7 +109,7 @@ submitTxConstraintsSpending
-> TxConstraints (RedeemerType a) (DatumType a)
-> Contract w s e Tx
submitTxConstraintsSpending inst utxo =
let lookups = Constraints.scriptInstanceLookups inst <> Constraints.unspentOutputs utxo
let lookups = Constraints.typedValidatorLookups inst <> Constraints.unspentOutputs utxo
in submitTxConstraintsWith lookups

-- | Build a transaction that satisfies the constraints, then submit it to the
Expand Down
12 changes: 6 additions & 6 deletions plutus-contract/src/Plutus/Contract/StateMachine.hs
Expand Up @@ -220,7 +220,7 @@ waitForUpdateUntil ::
-> Slot
-> Contract w schema e (WaitingResult state)
waitForUpdateUntil StateMachineClient{scInstance, scChooser} timeoutSlot = do
let addr = Scripts.validatorAddress $ validatorInstance scInstance
let addr = Scripts.validatorAddress $ typedValidator scInstance
let go sl = do
txns <- acrTxns <$> addressChangeRequest AddressChangeRequest
{ acreqSlotRangeFrom = sl
Expand Down Expand Up @@ -257,7 +257,7 @@ waitForUpdate ::
=> StateMachineClient state i
-> Contract w schema e (Maybe (OnChainState state i))
waitForUpdate StateMachineClient{scInstance, scChooser} = do
let addr = Scripts.validatorAddress $ validatorInstance scInstance
let addr = Scripts.validatorAddress $ typedValidator scInstance
txns <- nextTransactionsAt addr
let states = txns >>= getStates scInstance . outputsMapFromTxForAddress addr
case states of
Expand Down Expand Up @@ -331,9 +331,9 @@ runInitialise ::
-- ^ The value locked by the contract at the beginning
-> Contract w schema e state
runInitialise StateMachineClient{scInstance} initialState initialValue = mapError (review _SMContractError) $ do
let StateMachineInstance{validatorInstance, stateMachine} = scInstance
let StateMachineInstance{typedValidator, stateMachine} = scInstance
tx = mustPayToTheScript initialState (initialValue <> SM.threadTokenValue stateMachine)
let lookups = Constraints.scriptInstanceLookups validatorInstance
let lookups = Constraints.typedValidatorLookups typedValidator
utx <- either (throwing _ConstraintResolutionError) pure (Constraints.mkTx lookups tx)
submitTxConfirmed utx
pure initialState
Expand All @@ -360,7 +360,7 @@ mkStep ::
-> input
-> Contract w schema e (Either (InvalidTransition state input) (StateMachineTransition state input))
mkStep client@StateMachineClient{scInstance} input = do
let StateMachineInstance{stateMachine, validatorInstance} = scInstance
let StateMachineInstance{stateMachine, typedValidator} = scInstance
StateMachine{smTransition} = stateMachine
maybeState <- getOnChainState client
case maybeState of
Expand All @@ -373,7 +373,7 @@ mkStep client@StateMachineClient{scInstance} input = do
case smTransition oldState input of
Just (newConstraints, newState) ->
let lookups =
Constraints.scriptInstanceLookups validatorInstance
Constraints.typedValidatorLookups typedValidator
<> Constraints.unspentOutputs utxo
outputConstraints =
if smFinal (SM.stateMachine scInstance) (stateData newState)
Expand Down
4 changes: 2 additions & 2 deletions plutus-contract/src/Plutus/Contract/StateMachine/OnChain.hs
Expand Up @@ -96,11 +96,11 @@ data StateMachineInstance s i = StateMachineInstance {
-- | The state machine specification.
stateMachine :: StateMachine s i,
-- | The validator code for this state machine.
validatorInstance :: TypedValidator (StateMachine s i)
typedValidator :: TypedValidator (StateMachine s i)
}

machineAddress :: StateMachineInstance s i -> Address
machineAddress = validatorAddress . validatorInstance
machineAddress = validatorAddress . typedValidator

{-# INLINABLE mkValidator #-}
-- | Turn a state machine into a validator script.
Expand Down
4 changes: 2 additions & 2 deletions plutus-ledger/src/Ledger/Constraints.hs
Expand Up @@ -25,7 +25,7 @@ module Ledger.Constraints(
, ScriptLookups(..)
, MkTxError(..)
, UnbalancedTx
, scriptInstanceLookups
, typedValidatorLookups
, unspentOutputs
, monetaryPolicy
, otherScript
Expand All @@ -39,7 +39,7 @@ module Ledger.Constraints(

import Ledger.Constraints.OffChain (MkTxError (..), ScriptLookups (..), SomeLookupsAndConstraints (..),
UnbalancedTx, mkSomeTx, mkTx, monetaryPolicy, otherData, otherScript,
ownPubKeyHash, scriptInstanceLookups, unspentOutputs)
ownPubKeyHash, typedValidatorLookups, unspentOutputs)
import Ledger.Constraints.OnChain (checkScriptContext)
import Ledger.Constraints.TxConstraints

Expand Down
6 changes: 3 additions & 3 deletions plutus-ledger/src/Ledger/Constraints/OffChain.hs
Expand Up @@ -18,7 +18,7 @@
module Ledger.Constraints.OffChain(
-- * Lookups
ScriptLookups(..)
, scriptInstanceLookups
, typedValidatorLookups
, unspentOutputs
, monetaryPolicy
, otherScript
Expand Down Expand Up @@ -110,8 +110,8 @@ instance Monoid (ScriptLookups a) where
-- | A script lookups value with a script instance. For convenience this also
-- includes the monetary policy script that forwards all checks to the
-- instance's validator.
scriptInstanceLookups :: TypedValidator a -> ScriptLookups a
scriptInstanceLookups inst =
typedValidatorLookups :: TypedValidator a -> ScriptLookups a
typedValidatorLookups inst =
ScriptLookups
{ slMPS = Map.singleton (Scripts.forwardingMonetaryPolicyHash inst) (Scripts.forwardingMonetaryPolicy inst)
, slTxOutputs = Map.empty
Expand Down
2 changes: 1 addition & 1 deletion plutus-pab/examples/atomic-swap-contract/AtomicSwap.hs
Expand Up @@ -99,7 +99,7 @@ atomicSwap = do
-- redeeming transaction.
void $ mapError EscrowError (Escrow.payRedeemRefund params value2)
| pk == walletPubKey (party2 p) =
void $ mapError EscrowError (Escrow.pay (Escrow.scriptInstance params) params value1) >>= awaitTxConfirmed
void $ mapError EscrowError (Escrow.pay (Escrow.typedValidator params) params value1) >>= awaitTxConfirmed
| otherwise = throwError (NotInvolvedError pk p)

ownPubKey >>= go
10 changes: 5 additions & 5 deletions plutus-playground-server/usecases/Crowdfunding.hs
Expand Up @@ -100,8 +100,8 @@ instance Scripts.ValidatorTypes Crowdfunding where
type instance RedeemerType Crowdfunding = CampaignAction
type instance DatumType Crowdfunding = PubKeyHash

scriptInstance :: Campaign -> Scripts.TypedValidator Crowdfunding
scriptInstance = Scripts.mkTypedValidatorParam @Crowdfunding
typedValidator :: Campaign -> Scripts.TypedValidator Crowdfunding
typedValidator = Scripts.mkTypedValidatorParam @Crowdfunding
$$(PlutusTx.compile [|| mkValidator ||])
$$(PlutusTx.compile [|| wrap ||])
where
Expand Down Expand Up @@ -138,7 +138,7 @@ mkValidator c con act p = case act of
-- retrieve the funds or the contributors can claim a refund.
--
contributionScript :: Campaign -> Validator
contributionScript = Scripts.validatorScript . scriptInstance
contributionScript = Scripts.validatorScript . typedValidator

-- | The address of a [[Campaign]]
campaignAddress :: Campaign -> Ledger.ValidatorHash
Expand All @@ -164,7 +164,7 @@ contribute :: AsContractError e => Campaign -> Contract () CrowdfundingSchema e
contribute cmp = do
Contribution{contribValue} <- endpoint @"contribute"
contributor <- pubKeyHash <$> ownPubKey
let inst = scriptInstance cmp
let inst = typedValidator cmp
tx = Constraints.mustPayToTheScript contributor contribValue
<> Constraints.mustValidateIn (Ledger.interval 1 (campaignDeadline cmp))
txid <- fmap txId (submitTxConstraints inst tx)
Expand All @@ -188,7 +188,7 @@ contribute cmp = do
-- the funding goal was reached in time.
scheduleCollection :: AsContractError e => Campaign -> Contract () CrowdfundingSchema e ()
scheduleCollection cmp = do
let inst = scriptInstance cmp
let inst = typedValidator cmp

-- Expose an endpoint that lets the user fire the starting gun on the
-- campaign. (This endpoint isn't technically necessary, we could just
Expand Down
12 changes: 6 additions & 6 deletions plutus-playground-server/usecases/Vesting.hs
Expand Up @@ -134,17 +134,17 @@ instance Scripts.ValidatorTypes Vesting where
type instance DatumType Vesting = ()

vestingScript :: VestingParams -> Validator
vestingScript = Scripts.validatorScript . scriptInstance
vestingScript = Scripts.validatorScript . typedValidator

scriptInstance :: VestingParams -> Scripts.TypedValidator Vesting
scriptInstance = Scripts.mkTypedValidatorParam @Vesting
typedValidator :: VestingParams -> Scripts.TypedValidator Vesting
typedValidator = Scripts.mkTypedValidatorParam @Vesting
$$(PlutusTx.compile [|| validate ||])
$$(PlutusTx.compile [|| wrap ||])
where
wrap = Scripts.wrapValidator

contractAddress :: VestingParams -> Ledger.Address
contractAddress = Scripts.validatorAddress . scriptInstance
contractAddress = Scripts.validatorAddress . typedValidator

vestingContract :: VestingParams -> Contract () VestingSchema T.Text ()
vestingContract vesting = vest `select` retrieve
Expand All @@ -167,7 +167,7 @@ vestFundsC
-> Contract () s T.Text ()
vestFundsC vesting = do
let tx = payIntoContract (totalAmount vesting)
void $ submitTxConstraints (scriptInstance vesting) tx
void $ submitTxConstraints (typedValidator vesting) tx

data Liveness = Alive | Dead

Expand All @@ -180,7 +180,7 @@ retrieveFundsC
-> Value
-> Contract () s T.Text Liveness
retrieveFundsC vesting payment = do
let inst = scriptInstance vesting
let inst = typedValidator vesting
addr = Scripts.validatorAddress inst
nextSlot <- awaitSlot 0
unspentOutputs <- utxoAt addr
Expand Down
14 changes: 7 additions & 7 deletions plutus-use-cases/bench/Bench.hs
Expand Up @@ -220,22 +220,22 @@ multisig :: Benchmark
multisig = bgroup "multisig" [
bench "1of1" $ nf runScript'
(validationData2
, Scripts.validatorScript $ MS.scriptInstance msScen1of1
, Scripts.validatorScript $ MS.typedValidator msScen1of1
, unitDatum
, unitRedeemer),
bench "1of2" $ nf runScript'
(validationData2
, Scripts.validatorScript $ MS.scriptInstance msScen1of2
, Scripts.validatorScript $ MS.typedValidator msScen1of2
, unitDatum
, unitRedeemer),
bench "2of2" $ nf runScript'
(validationData2
, Scripts.validatorScript $ MS.scriptInstance msScen2of2
, Scripts.validatorScript $ MS.typedValidator msScen2of2
, unitDatum
, unitRedeemer),
bench "typecheck" $ nf runScript'
(validationData2
, Scripts.validatorScript $ MS.scriptInstance msScen1of1
, Scripts.validatorScript $ MS.typedValidator msScen1of1
, unitDatum
, unitRedeemer)
]
Expand Down Expand Up @@ -298,10 +298,10 @@ mockCtx = ScriptContext
scriptHashes :: Benchmark
scriptHashes = bgroup "script hashes" [
let ac = assetClass "fd2c8c0705d3ca1e7b1aeaa4da85dfe5ac6dde64da9d241011d84c0ee97aac5e" "my token"
si = TA.scriptInstance (TA.Account ac) in
si = TA.typedValidator (TA.Account ac) in
bench "token account" $ nf Scripts.validatorScript si
, bench "public key" $ nf (Scripts.validatorScript . PK.scriptInstance) (pubKeyHash $ walletPubKey $ Wallet 2)
, bench "future" $ nf (Scripts.validatorScript . FT.scriptInstance theFuture) accounts
, bench "public key" $ nf (Scripts.validatorScript . PK.typedValidator) (pubKeyHash $ walletPubKey $ Wallet 2)
, bench "future" $ nf (Scripts.validatorScript . FT.typedValidator theFuture) accounts
]

-- | A futures contract over 187 units with a forward price of 1233 Lovelace,
Expand Down

0 comments on commit 19ca004

Please sign in to comment.