From 864e4073ce8488a27d2425a3b908e5ebf7bc6c1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Thu, 8 Jul 2021 13:39:51 +0200 Subject: [PATCH 1/4] bumped Plutus dependency --- code/week03/.devcontainer/devcontainer.json | 23 ++ code/week03/.gitignore | 1 + code/week03/LICENSE | 201 ++++++++++++++++++ code/week03/cabal.project | 193 +++++++++++++++++ code/week03/hie.yaml | 4 + .../plutus-pioneer-program-week03.cabal | 31 +++ code/week03/src/Week03/Homework1.hs | 138 ++++++++++++ code/week03/src/Week03/Homework2.hs | 112 ++++++++++ code/week03/src/Week03/IsData.hs | 90 ++++++++ code/week03/src/Week03/Parameterized.hs | 135 ++++++++++++ code/week03/src/Week03/Solution1.hs | 145 +++++++++++++ code/week03/src/Week03/Solution2.hs | 127 +++++++++++ code/week03/src/Week03/Vesting.hs | 135 ++++++++++++ 13 files changed, 1335 insertions(+) create mode 100644 code/week03/.devcontainer/devcontainer.json create mode 100644 code/week03/.gitignore create mode 100644 code/week03/LICENSE create mode 100644 code/week03/cabal.project create mode 100644 code/week03/hie.yaml create mode 100644 code/week03/plutus-pioneer-program-week03.cabal create mode 100644 code/week03/src/Week03/Homework1.hs create mode 100644 code/week03/src/Week03/Homework2.hs create mode 100644 code/week03/src/Week03/IsData.hs create mode 100644 code/week03/src/Week03/Parameterized.hs create mode 100644 code/week03/src/Week03/Solution1.hs create mode 100644 code/week03/src/Week03/Solution2.hs create mode 100644 code/week03/src/Week03/Vesting.hs diff --git a/code/week03/.devcontainer/devcontainer.json b/code/week03/.devcontainer/devcontainer.json new file mode 100644 index 0000000..51f7dce --- /dev/null +++ b/code/week03/.devcontainer/devcontainer.json @@ -0,0 +1,23 @@ +{ + "name": "Plutus Starter Project", + "image": "plutus-devcontainer:latest", + + "remoteUser": "plutus", + + "mounts": [ + // This shares cabal's remote repository state with the host. We don't mount the whole of '.cabal', because + // 1. '.cabal/config' contains absolute paths that will only make sense on the host, and + // 2. '.cabal/store' is not necessarily portable to different version of cabal etc. + "source=${localEnv:HOME}/.cabal/packages,target=/home/plutus/.cabal/packages,type=bind,consistency=cached", + ], + + "settings": { + // Note: don't change from bash so it runs .bashrc + "terminal.integrated.shell.linux": "/bin/bash" + }, + + // IDs of extensions inside container + "extensions": [ + "haskell.haskell" + ], +} diff --git a/code/week03/.gitignore b/code/week03/.gitignore new file mode 100644 index 0000000..c33954f --- /dev/null +++ b/code/week03/.gitignore @@ -0,0 +1 @@ +dist-newstyle/ diff --git a/code/week03/LICENSE b/code/week03/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/code/week03/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/code/week03/cabal.project b/code/week03/cabal.project new file mode 100644 index 0000000..41d6dbc --- /dev/null +++ b/code/week03/cabal.project @@ -0,0 +1,193 @@ +index-state: 2021-06-10T00:00:00Z + +packages: ./. + +-- You never, ever, want this. +write-ghc-environment-files: never + +-- Always build tests and benchmarks. +tests: true +benchmarks: true + +source-repository-package + type: git + location: https://github.com/input-output-hk/plutus.git + subdir: + freer-extras + playground-common + plutus-chain-index + plutus-core + plutus-contract + plutus-ledger + plutus-ledger-api + plutus-tx + plutus-tx-plugin + prettyprinter-configurable + quickcheck-dynamic + word-array + tag: 08260fab8e1e695b288637c32a2248cdd7d264d4 + +-- The following sections are copied from the 'plutus' repository cabal.project at the revision +-- given above. +-- This is necessary because the 'plutus' libraries depend on a number of other libraries which are +-- not on Hackage, and so need to be pulled in as `source-repository-package`s themselves. Make sure to +-- re-update this section from the template when you do an upgrade. + +-- This is also needed so evenful-sql-common will build with a +-- newer version of persistent. See stack.yaml for the mirrored +-- configuration. +package eventful-sql-common + ghc-options: -XDerivingStrategies -XStandaloneDeriving -XUndecidableInstances -XDataKinds -XFlexibleInstances -XMultiParamTypeClasses + +allow-newer: + -- Pins to an old version of Template Haskell, unclear if/when it will be updated + size-based:template-haskell + + -- The following two dependencies are needed by plutus. + , eventful-sql-common:persistent + , eventful-sql-common:persistent-template + , ouroboros-consensus-byron:formatting + , beam-core:aeson + , beam-sqlite:aeson + , beam-sqlite:dlist + , beam-migrate:aeson + +constraints: + -- big breaking change here, inline-r doens't have an upper bound + singletons < 3.0 + -- breaks eventful even more than it already was + , persistent-template < 2.12 + -- bizarre issue: in earlier versions they define their own 'GEq', in newer + -- ones they reuse the one from 'some', but there isn't e.g. a proper version + -- constraint from dependent-sum-template (which is the library we actually use). + , dependent-sum > 0.6.2.0 + +-- See the note on nix/pkgs/default.nix:agdaPackages for why this is here. +-- (NOTE this will change to ieee754 in newer versions of nixpkgs). +extra-packages: ieee, filemanip + +-- Drops an instance breaking our code. Should be released to Hackage eventually. +source-repository-package + type: git + location: https://github.com/Quid2/flat.git + tag: 95e5d7488451e43062ca84d5376b3adcc465f1cd + +-- Needs some patches, but upstream seems to be fairly dead (no activity in > 1 year) +source-repository-package + type: git + location: https://github.com/shmish111/purescript-bridge.git + tag: 6a92d7853ea514be8b70bab5e72077bf5a510596 + +source-repository-package + type: git + location: https://github.com/shmish111/servant-purescript.git + tag: a76104490499aa72d40c2790d10e9383e0dbde63 + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-crypto.git + tag: ce8f1934e4b6252084710975bd9bbc0a4648ece4 + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-base + tag: a715c7f420770b70bbe95ca51d3dec83866cb1bd + subdir: + binary + binary/test + slotting + cardano-crypto-class + cardano-crypto-praos + cardano-crypto-tests + strict-containers + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-prelude + tag: fd773f7a58412131512b9f694ab95653ac430852 + subdir: + cardano-prelude + cardano-prelude-test + +source-repository-package + type: git + location: https://github.com/input-output-hk/ouroboros-network + tag: e50613562d6d4a0f933741fcf590b0f69a1eda67 + subdir: + typed-protocols + typed-protocols-examples + ouroboros-network + ouroboros-network-testing + ouroboros-network-framework + ouroboros-consensus + ouroboros-consensus-byron + ouroboros-consensus-cardano + ouroboros-consensus-shelley + io-sim + io-sim-classes + network-mux + +source-repository-package + type: git + location: https://github.com/input-output-hk/iohk-monitoring-framework + tag: 34abfb7f4f5610cabb45396e0496472446a0b2ca + subdir: + iohk-monitoring + tracer-transformers + contra-tracer + plugins/backend-aggregation + plugins/backend-ekg + plugins/backend-monitoring + plugins/backend-trace-forwarder + plugins/scribe-systemd + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-ledger-specs + tag: a3ef848542961079b7cd53d599e5385198a3035c + subdir: + byron/chain/executable-spec + byron/crypto + byron/crypto/test + byron/ledger/executable-spec + byron/ledger/impl + byron/ledger/impl/test + semantics/executable-spec + semantics/small-steps-test + shelley/chain-and-ledger/dependencies/non-integer + shelley/chain-and-ledger/executable-spec + shelley/chain-and-ledger/shelley-spec-ledger-test + shelley-ma/impl + cardano-ledger-core + alonzo/impl + +-- A lot of plutus dependencies have to be synchronized with the dependencies of +-- cardano-node. If you update cardano-node, please make sure that all dependencies +-- of cardano-node are also updated. +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-node.git + tag: b3cabae6b3bf30a0b1b4e78bc4b67282dabad0a6 + subdir: + cardano-api/test + cardano-api + cardano-node + cardano-cli + cardano-config + +source-repository-package + type: git + location: https://github.com/input-output-hk/Win32-network + tag: 94153b676617f8f33abe8d8182c37377d2784bd1 + +source-repository-package + type: git + location: https://github.com/input-output-hk/hedgehog-extras + tag: 8bcd3c9dc22cc44f9fcfe161f4638a384fc7a187 + +-- The following dependencies are not mirrored in the +-- stack.yaml file, but they are needed regardless by cabal. +source-repository-package + type: git + location: https://github.com/input-output-hk/goblins + tag: cde90a2b27f79187ca8310b6549331e59595e7ba diff --git a/code/week03/hie.yaml b/code/week03/hie.yaml new file mode 100644 index 0000000..fafb578 --- /dev/null +++ b/code/week03/hie.yaml @@ -0,0 +1,4 @@ +cradle: + cabal: + - path: "./src" + component: "lib:plutus-pioneer-program-week03" diff --git a/code/week03/plutus-pioneer-program-week03.cabal b/code/week03/plutus-pioneer-program-week03.cabal new file mode 100644 index 0000000..f087323 --- /dev/null +++ b/code/week03/plutus-pioneer-program-week03.cabal @@ -0,0 +1,31 @@ +Cabal-Version: 2.4 +Name: plutus-pioneer-program-week03 +Version: 0.1.0.0 +Author: Lars Bruenjes +Maintainer: brunjlar@gmail.com +Build-Type: Simple +Copyright: © 2021 Lars Bruenjes +License: Apache-2.0 +License-files: LICENSE + +library + hs-source-dirs: src + exposed-modules: Week03.IsData + , Week03.Homework1 + , Week03.Homework2 + , Week03.Parameterized + , Week03.Solution1 + , Week03.Solution2 + , Week03.Vesting + build-depends: aeson + , base ^>=4.14.1.0 + , containers + , playground-common + , plutus-contract + , plutus-ledger + , plutus-ledger-api + , plutus-tx-plugin + , plutus-tx + , text + default-language: Haskell2010 + ghc-options: -Wall -fobject-code -fno-ignore-interface-pragmas -fno-omit-interface-pragmas -fno-strictness -fno-spec-constr -fno-specialise diff --git a/code/week03/src/Week03/Homework1.hs b/code/week03/src/Week03/Homework1.hs new file mode 100644 index 0000000..5b9b0a9 --- /dev/null +++ b/code/week03/src/Week03/Homework1.hs @@ -0,0 +1,138 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +module Week03.Homework1 where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO) +import qualified Prelude as P +import Text.Printf (printf) + +data VestingDatum = VestingDatum + { beneficiary1 :: PubKeyHash + , beneficiary2 :: PubKeyHash + , deadline :: POSIXTime + } deriving P.Show + +PlutusTx.unstableMakeIsData ''VestingDatum + +{-# INLINABLE mkValidator #-} +-- This should validate if either beneficiary1 has signed the transaction and the current slot is before or at the deadline +-- or if beneficiary2 has signed the transaction and the deadline has passed. +mkValidator :: VestingDatum -> () -> ScriptContext -> Bool +mkValidator _ _ _ = False -- FIX ME! + +data Vesting +instance Scripts.ValidatorTypes Vesting where + type instance DatumType Vesting = VestingDatum + type instance RedeemerType Vesting = () + +typedValidator :: Scripts.TypedValidator Vesting +typedValidator = Scripts.mkTypedValidator @Vesting + $$(PlutusTx.compile [|| mkValidator ||]) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @VestingDatum @() + +validator :: Validator +validator = Scripts.validatorScript typedValidator + +valHash :: Ledger.ValidatorHash +valHash = Scripts.validatorHash typedValidator + +scrAddress :: Ledger.Address +scrAddress = scriptAddress validator + +data GiveParams = GiveParams + { gpBeneficiary :: !PubKeyHash + , gpDeadline :: !POSIXTime + , gpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type VestingSchema = + Endpoint "give" GiveParams + .\/ Endpoint "grab" () + +give :: AsContractError e => GiveParams -> Contract w s e () +give gp = do + pkh <- pubKeyHash <$> ownPubKey + let dat = VestingDatum + { beneficiary1 = gpBeneficiary gp + , beneficiary2 = pkh + , deadline = gpDeadline gp + } + tx = mustPayToTheScript dat $ Ada.lovelaceValueOf $ gpAmount gp + ledgerTx <- submitTxConstraints typedValidator tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @P.String $ printf "made a gift of %d lovelace to %s with deadline %s" + (gpAmount gp) + (P.show $ gpBeneficiary gp) + (P.show $ gpDeadline gp) + +grab :: forall w s e. AsContractError e => Contract w s e () +grab = do + now <- currentTime + pkh <- pubKeyHash <$> ownPubKey + utxos <- utxoAt scrAddress + let utxos1 = Map.filter (isSuitable $ \dat -> beneficiary1 dat == pkh && now <= deadline dat) utxos + utxos2 = Map.filter (isSuitable $ \dat -> beneficiary2 dat == pkh && now > deadline dat) utxos + logInfo @P.String $ printf "found %d gift(s) to grab" (Map.size utxos1 P.+ Map.size utxos2) + unless (Map.null utxos1) $ do + let orefs = fst <$> Map.toList utxos1 + lookups = Constraints.unspentOutputs utxos1 P.<> + Constraints.otherScript validator + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] P.<> + mustValidateIn (to now) + void $ submitTxConstraintsWith @Void lookups tx + unless (Map.null utxos2) $ do + let orefs = fst <$> Map.toList utxos2 + lookups = Constraints.unspentOutputs utxos2 P.<> + Constraints.otherScript validator + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] P.<> + mustValidateIn (from now) + void $ submitTxConstraintsWith @Void lookups tx + where + isSuitable :: (VestingDatum -> Bool) -> TxOutTx -> Bool + isSuitable p o = case txOutDatumHash $ txOutTxOut o of + Nothing -> False + Just h -> case Map.lookup h $ txData $ txOutTxTx o of + Nothing -> False + Just (Datum e) -> maybe False p $ PlutusTx.fromData e + +endpoints :: Contract () VestingSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >> grab + +mkSchemaDefinitions ''VestingSchema + +mkKnownCurrencies [] diff --git a/code/week03/src/Week03/Homework2.hs b/code/week03/src/Week03/Homework2.hs new file mode 100644 index 0000000..06d4a2d --- /dev/null +++ b/code/week03/src/Week03/Homework2.hs @@ -0,0 +1,112 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week03.Homework2 where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String, undefined) +import Text.Printf (printf) + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +{-# INLINABLE mkValidator #-} +mkValidator :: PubKeyHash -> POSIXTime -> () -> ScriptContext -> Bool +mkValidator _ _ _ _ = False -- FIX ME! + +data Vesting +instance Scripts.ValidatorTypes Vesting where + type instance DatumType Vesting = POSIXTime + type instance RedeemerType Vesting = () + +typedValidator :: PubKeyHash -> Scripts.TypedValidator Vesting +typedValidator = undefined -- IMPLEMENT ME! + +validator :: PubKeyHash -> Validator +validator = undefined -- IMPLEMENT ME! + +scrAddress :: PubKeyHash -> Ledger.Address +scrAddress = undefined -- IMPLEMENT ME! + +data GiveParams = GiveParams + { gpBeneficiary :: !PubKeyHash + , gpDeadline :: !POSIXTime + , gpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type VestingSchema = + Endpoint "give" GiveParams + .\/ Endpoint "grab" () + +give :: AsContractError e => GiveParams -> Contract w s e () +give gp = do + let p = gpBeneficiary gp + d = gpDeadline gp + tx = mustPayToTheScript d $ Ada.lovelaceValueOf $ gpAmount gp + ledgerTx <- submitTxConstraints (typedValidator p) tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "made a gift of %d lovelace to %s with deadline %s" + (gpAmount gp) + (show $ gpBeneficiary gp) + (show $ gpDeadline gp) + +grab :: forall w s e. AsContractError e => Contract w s e () +grab = do + now <- currentTime + pkh <- pubKeyHash <$> ownPubKey + utxos <- Map.filter (isSuitable now) <$> utxoAt (scrAddress pkh) + if Map.null utxos + then logInfo @String $ "no gifts available" + else do + let orefs = fst <$> Map.toList utxos + lookups = Constraints.unspentOutputs utxos <> + Constraints.otherScript (validator pkh) + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] <> + mustValidateIn (from now) + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "collected gifts" + where + isSuitable :: POSIXTime -> TxOutTx -> Bool + isSuitable now o = case txOutDatumHash $ txOutTxOut o of + Nothing -> False + Just h -> case Map.lookup h $ txData $ txOutTxTx o of + Nothing -> False + Just (Datum e) -> case PlutusTx.fromData e of + Nothing -> False + Just d -> d <= now + +endpoints :: Contract () VestingSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >> grab + +mkSchemaDefinitions ''VestingSchema + +mkKnownCurrencies [] diff --git a/code/week03/src/Week03/IsData.hs b/code/week03/src/Week03/IsData.hs new file mode 100644 index 0000000..05b9e3f --- /dev/null +++ b/code/week03/src/Week03/IsData.hs @@ -0,0 +1,90 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +module Week03.IsData where + +import Control.Monad hiding (fmap) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show, String) +import Text.Printf (printf) + +newtype MySillyRedeemer = MySillyRedeemer Integer + deriving Show + +PlutusTx.unstableMakeIsData ''MySillyRedeemer + +{-# INLINABLE mkValidator #-} +mkValidator :: () -> MySillyRedeemer -> ScriptContext -> Bool +mkValidator () (MySillyRedeemer r) _ = traceIfFalse "wrong redeemer" $ r == 42 + +data Typed +instance Scripts.ValidatorTypes Typed where + type instance DatumType Typed = () + type instance RedeemerType Typed = MySillyRedeemer + +typedValidator :: Scripts.TypedValidator Typed +typedValidator = Scripts.mkTypedValidator @Typed + $$(PlutusTx.compile [|| mkValidator ||]) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @() @MySillyRedeemer + +validator :: Validator +validator = Scripts.validatorScript typedValidator + +scrAddress :: Ledger.Address +scrAddress = scriptAddress validator + +type GiftSchema = + Endpoint "give" Integer + .\/ Endpoint "grab" Integer + +give :: AsContractError e => Integer -> Contract w s e () +give amount = do + let tx = mustPayToTheScript () $ Ada.lovelaceValueOf amount + ledgerTx <- submitTxConstraints typedValidator tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "made a gift of %d lovelace" amount + +grab :: forall w s e. AsContractError e => Integer -> Contract w s e () +grab r = do + utxos <- utxoAt scrAddress + let orefs = fst <$> Map.toList utxos + lookups = Constraints.unspentOutputs utxos <> + Constraints.otherScript validator + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData $ MySillyRedeemer r | oref <- orefs] + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "collected gifts" + +endpoints :: Contract () GiftSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >>= grab + +mkSchemaDefinitions ''GiftSchema + +mkKnownCurrencies [] diff --git a/code/week03/src/Week03/Parameterized.hs b/code/week03/src/Week03/Parameterized.hs new file mode 100644 index 0000000..43839c1 --- /dev/null +++ b/code/week03/src/Week03/Parameterized.hs @@ -0,0 +1,135 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week03.Parameterized where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String) +import Text.Printf (printf) + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +data VestingParam = VestingParam + { beneficiary :: PubKeyHash + , deadline :: POSIXTime + } deriving Show + +PlutusTx.unstableMakeIsData ''VestingParam +PlutusTx.makeLift ''VestingParam + +{-# INLINABLE mkValidator #-} +mkValidator :: VestingParam -> () -> () -> ScriptContext -> Bool +mkValidator p () () ctx = + traceIfFalse "beneficiary's signature missing" checkSig && + traceIfFalse "deadline not reached" checkDeadline + where + info :: TxInfo + info = scriptContextTxInfo ctx + + checkSig :: Bool + checkSig = beneficiary p `elem` txInfoSignatories info + + checkDeadline :: Bool + checkDeadline = from (deadline p) `contains` txInfoValidRange info + +data Vesting +instance Scripts.ValidatorTypes Vesting where + type instance DatumType Vesting = () + type instance RedeemerType Vesting = () + +inst :: VestingParam -> Scripts.TypedValidator Vesting +inst p = Scripts.mkTypedValidator @Vesting + ($$(PlutusTx.compile [|| mkValidator ||]) `PlutusTx.applyCode` PlutusTx.liftCode p) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @() @() + +validator :: VestingParam -> Validator +validator = Scripts.validatorScript . inst + +scrAddress :: VestingParam -> Ledger.Address +scrAddress = scriptAddress . validator + +data GiveParams = GiveParams + { gpBeneficiary :: !PubKeyHash + , gpDeadline :: !POSIXTime + , gpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type VestingSchema = + Endpoint "give" GiveParams + .\/ Endpoint "grab" POSIXTime + +give :: AsContractError e => GiveParams -> Contract w s e () +give gp = do + let p = VestingParam + { beneficiary = gpBeneficiary gp + , deadline = gpDeadline gp + } + tx = mustPayToTheScript () $ Ada.lovelaceValueOf $ gpAmount gp + ledgerTx <- submitTxConstraints (inst p) tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "made a gift of %d lovelace to %s with deadline %s" + (gpAmount gp) + (show $ gpBeneficiary gp) + (show $ gpDeadline gp) + +grab :: forall w s e. AsContractError e => POSIXTime -> Contract w s e () +grab d = do + now <- currentTime + pkh <- pubKeyHash <$> ownPubKey + if now < d + then logInfo @String $ "too early" + else do + let p = VestingParam + { beneficiary = pkh + , deadline = d + } + utxos <- utxoAt $ scrAddress p + if Map.null utxos + then logInfo @String $ "no gifts available" + else do + let orefs = fst <$> Map.toList utxos + lookups = Constraints.unspentOutputs utxos <> + Constraints.otherScript (validator p) + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] <> + mustValidateIn (from now) + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "collected gifts" + +endpoints :: Contract () VestingSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >>= grab + +mkSchemaDefinitions ''VestingSchema + +mkKnownCurrencies [] diff --git a/code/week03/src/Week03/Solution1.hs b/code/week03/src/Week03/Solution1.hs new file mode 100644 index 0000000..d9fe216 --- /dev/null +++ b/code/week03/src/Week03/Solution1.hs @@ -0,0 +1,145 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +module Week03.Solution1 where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Show (..), String) +import qualified Prelude as P +import Text.Printf (printf) + +data VestingDatum = VestingDatum + { beneficiary1 :: PubKeyHash + , beneficiary2 :: PubKeyHash + , deadline :: POSIXTime + } deriving Show + +PlutusTx.unstableMakeIsData ''VestingDatum + +{-# INLINABLE mkValidator #-} +mkValidator :: VestingDatum -> () -> ScriptContext -> Bool +mkValidator dat () ctx + | (beneficiary1 dat `elem` sigs) && (to (deadline dat) `contains` range) = True + | (beneficiary2 dat `elem` sigs) && (from (1 + deadline dat) `contains` range) = True + | otherwise = False + where + info :: TxInfo + info = scriptContextTxInfo ctx + + sigs :: [PubKeyHash] + sigs = txInfoSignatories info + + range :: POSIXTimeRange + range = txInfoValidRange info + +data Vesting +instance Scripts.ValidatorTypes Vesting where + type instance DatumType Vesting = VestingDatum + type instance RedeemerType Vesting = () + +typedValidator :: Scripts.TypedValidator Vesting +typedValidator = Scripts.mkTypedValidator @Vesting + $$(PlutusTx.compile [|| mkValidator ||]) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @VestingDatum @() + +validator :: Validator +validator = Scripts.validatorScript typedValidator + +scrAddress :: Ledger.Address +scrAddress = scriptAddress validator + +data GiveParams = GiveParams + { gpBeneficiary :: !PubKeyHash + , gpDeadline :: !POSIXTime + , gpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type VestingSchema = + Endpoint "give" GiveParams + .\/ Endpoint "grab" () + +give :: AsContractError e => GiveParams -> Contract w s e () +give gp = do + pkh <- pubKeyHash <$> ownPubKey + let dat = VestingDatum + { beneficiary1 = gpBeneficiary gp + , beneficiary2 = pkh + , deadline = gpDeadline gp + } + tx = mustPayToTheScript dat $ Ada.lovelaceValueOf $ gpAmount gp + ledgerTx <- submitTxConstraints typedValidator tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "made a gift of %d lovelace to %s with deadline %s" + (gpAmount gp) + (show $ gpBeneficiary gp) + (show $ gpDeadline gp) + +grab :: forall w s e. AsContractError e => Contract w s e () +grab = do + now <- currentTime + pkh <- pubKeyHash <$> ownPubKey + utxos <- utxoAt scrAddress + let utxos1 = Map.filter (isSuitable $ \dat -> beneficiary1 dat == pkh && now <= deadline dat) utxos + utxos2 = Map.filter (isSuitable $ \dat -> beneficiary2 dat == pkh && now > deadline dat) utxos + logInfo @String $ printf "found %d gift(s) to grab" (Map.size utxos1 P.+ Map.size utxos2) + unless (Map.null utxos1) $ do + let orefs = fst <$> Map.toList utxos1 + lookups = Constraints.unspentOutputs utxos1 P.<> + Constraints.otherScript validator + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] P.<> + mustValidateIn (to now) + void $ submitTxConstraintsWith @Void lookups tx + unless (Map.null utxos2) $ do + let orefs = fst <$> Map.toList utxos2 + lookups = Constraints.unspentOutputs utxos2 P.<> + Constraints.otherScript validator + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] P.<> + mustValidateIn (from now) + void $ submitTxConstraintsWith @Void lookups tx + where + isSuitable :: (VestingDatum -> Bool) -> TxOutTx -> Bool + isSuitable p o = case txOutDatumHash $ txOutTxOut o of + Nothing -> False + Just h -> case Map.lookup h $ txData $ txOutTxTx o of + Nothing -> False + Just (Datum e) -> maybe False p $ PlutusTx.fromData e + +endpoints :: Contract () VestingSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >> grab + +mkSchemaDefinitions ''VestingSchema + +mkKnownCurrencies [] diff --git a/code/week03/src/Week03/Solution2.hs b/code/week03/src/Week03/Solution2.hs new file mode 100644 index 0000000..041f123 --- /dev/null +++ b/code/week03/src/Week03/Solution2.hs @@ -0,0 +1,127 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +module Week03.Solution2 where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String) +import Text.Printf (printf) + +{-# INLINABLE mkValidator #-} +mkValidator :: PubKeyHash -> POSIXTime -> () -> ScriptContext -> Bool +mkValidator pkh s () ctx = + traceIfFalse "beneficiary's signature missing" checkSig && + traceIfFalse "deadline not reached" checkDeadline + where + info :: TxInfo + info = scriptContextTxInfo ctx + + checkSig :: Bool + checkSig = pkh `elem` txInfoSignatories info + + checkDeadline :: Bool + checkDeadline = from s `contains` txInfoValidRange info + +data Vesting +instance Scripts.ValidatorTypes Vesting where + type instance DatumType Vesting = POSIXTime + type instance RedeemerType Vesting = () + +typedValidator :: PubKeyHash -> Scripts.TypedValidator Vesting +typedValidator p = Scripts.mkTypedValidator @Vesting + ($$(PlutusTx.compile [|| mkValidator ||]) `PlutusTx.applyCode` PlutusTx.liftCode p) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @POSIXTime @() + +validator :: PubKeyHash -> Validator +validator = Scripts.validatorScript . typedValidator + +scrAddress :: PubKeyHash -> Ledger.Address +scrAddress = scriptAddress . validator + +data GiveParams = GiveParams + { gpBeneficiary :: !PubKeyHash + , gpDeadline :: !POSIXTime + , gpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type VestingSchema = + Endpoint "give" GiveParams + .\/ Endpoint "grab" () + +give :: AsContractError e => GiveParams -> Contract w s e () +give gp = do + let p = gpBeneficiary gp + d = gpDeadline gp + tx = mustPayToTheScript d $ Ada.lovelaceValueOf $ gpAmount gp + ledgerTx <- submitTxConstraints (typedValidator p) tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "made a gift of %d lovelace to %s with deadline %s" + (gpAmount gp) + (show $ gpBeneficiary gp) + (show $ gpDeadline gp) + +grab :: forall w s e. AsContractError e => Contract w s e () +grab = do + now <- currentTime + pkh <- pubKeyHash <$> ownPubKey + utxos <- Map.filter (isSuitable now) <$> utxoAt (scrAddress pkh) + if Map.null utxos + then logInfo @String $ "no gifts available" + else do + let orefs = fst <$> Map.toList utxos + lookups = Constraints.unspentOutputs utxos <> + Constraints.otherScript (validator pkh) + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] <> + mustValidateIn (from now) + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "collected gifts" + where + isSuitable :: POSIXTime -> TxOutTx -> Bool + isSuitable now o = case txOutDatumHash $ txOutTxOut o of + Nothing -> False + Just h -> case Map.lookup h $ txData $ txOutTxTx o of + Nothing -> False + Just (Datum e) -> case PlutusTx.fromData e of + Nothing -> False + Just d -> d <= now + +endpoints :: Contract () VestingSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >> grab + +mkSchemaDefinitions ''VestingSchema + +mkKnownCurrencies [] diff --git a/code/week03/src/Week03/Vesting.hs b/code/week03/src/Week03/Vesting.hs new file mode 100644 index 0000000..bc08e43 --- /dev/null +++ b/code/week03/src/Week03/Vesting.hs @@ -0,0 +1,135 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +module Week03.Vesting where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String) +import Text.Printf (printf) + +data VestingDatum = VestingDatum + { beneficiary :: PubKeyHash + , deadline :: POSIXTime + } deriving Show + +PlutusTx.unstableMakeIsData ''VestingDatum + +{-# INLINABLE mkValidator #-} +mkValidator :: VestingDatum -> () -> ScriptContext -> Bool +mkValidator dat () ctx = + traceIfFalse "beneficiary's signature missing" checkSig && + traceIfFalse "deadline not reached" checkDeadline + where + info :: TxInfo + info = scriptContextTxInfo ctx + + checkSig :: Bool + checkSig = beneficiary dat `elem` txInfoSignatories info + + checkDeadline :: Bool + checkDeadline = from (deadline dat) `contains` txInfoValidRange info + +data Vesting +instance Scripts.ValidatorTypes Vesting where + type instance DatumType Vesting = VestingDatum + type instance RedeemerType Vesting = () + +typedValidator :: Scripts.TypedValidator Vesting +typedValidator = Scripts.mkTypedValidator @Vesting + $$(PlutusTx.compile [|| mkValidator ||]) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @VestingDatum @() + +validator :: Validator +validator = Scripts.validatorScript typedValidator + +scrAddress :: Ledger.Address +scrAddress = scriptAddress validator + +data GiveParams = GiveParams + { gpBeneficiary :: !PubKeyHash + , gpDeadline :: !POSIXTime + , gpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type VestingSchema = + Endpoint "give" GiveParams + .\/ Endpoint "grab" () + +give :: AsContractError e => GiveParams -> Contract w s e () +give gp = do + let dat = VestingDatum + { beneficiary = gpBeneficiary gp + , deadline = gpDeadline gp + } + tx = mustPayToTheScript dat $ Ada.lovelaceValueOf $ gpAmount gp + ledgerTx <- submitTxConstraints typedValidator tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "made a gift of %d lovelace to %s with deadline %s" + (gpAmount gp) + (show $ gpBeneficiary gp) + (show $ gpDeadline gp) + +grab :: forall w s e. AsContractError e => Contract w s e () +grab = do + now <- currentTime + pkh <- pubKeyHash <$> ownPubKey + utxos <- Map.filter (isSuitable pkh now) <$> utxoAt scrAddress + if Map.null utxos + then logInfo @String $ "no gifts available" + else do + let orefs = fst <$> Map.toList utxos + lookups = Constraints.unspentOutputs utxos <> + Constraints.otherScript validator + tx :: TxConstraints Void Void + tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData () | oref <- orefs] <> + mustValidateIn (from now) + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "collected gifts" + where + isSuitable :: PubKeyHash -> POSIXTime -> TxOutTx -> Bool + isSuitable pkh now o = case txOutDatumHash $ txOutTxOut o of + Nothing -> False + Just h -> case Map.lookup h $ txData $ txOutTxTx o of + Nothing -> False + Just (Datum e) -> case PlutusTx.fromData e of + Nothing -> False + Just d -> beneficiary d == pkh && deadline d <= now + +endpoints :: Contract () VestingSchema Text () +endpoints = (give' `select` grab') >> endpoints + where + give' = endpoint @"give" >>= give + grab' = endpoint @"grab" >> grab + +mkSchemaDefinitions ''VestingSchema + +mkKnownCurrencies [] From 840d80a5853fd83b35be0b9ea968215a135e1aea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Wed, 14 Jul 2021 17:37:34 +0200 Subject: [PATCH 2/4] small modifications --- .../plutus-pioneer-program-week03.cabal | 4 +- code/week03/src/Week03/IsData.hs | 90 ------------------- code/week03/src/Week03/Parameterized.hs | 30 ++++--- code/week03/src/Week03/Vesting.hs | 17 ++-- 4 files changed, 28 insertions(+), 113 deletions(-) delete mode 100644 code/week03/src/Week03/IsData.hs diff --git a/code/week03/plutus-pioneer-program-week03.cabal b/code/week03/plutus-pioneer-program-week03.cabal index f087323..91502dd 100644 --- a/code/week03/plutus-pioneer-program-week03.cabal +++ b/code/week03/plutus-pioneer-program-week03.cabal @@ -10,8 +10,7 @@ License-files: LICENSE library hs-source-dirs: src - exposed-modules: Week03.IsData - , Week03.Homework1 + exposed-modules: Week03.Homework1 , Week03.Homework2 , Week03.Parameterized , Week03.Solution1 @@ -20,6 +19,7 @@ library build-depends: aeson , base ^>=4.14.1.0 , containers + , data-default , playground-common , plutus-contract , plutus-ledger diff --git a/code/week03/src/Week03/IsData.hs b/code/week03/src/Week03/IsData.hs deleted file mode 100644 index 05b9e3f..0000000 --- a/code/week03/src/Week03/IsData.hs +++ /dev/null @@ -1,90 +0,0 @@ -{-# LANGUAGE DataKinds #-} -{-# LANGUAGE FlexibleContexts #-} -{-# LANGUAGE NoImplicitPrelude #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TemplateHaskell #-} -{-# LANGUAGE TypeApplications #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE TypeOperators #-} - -{-# OPTIONS_GHC -fno-warn-unused-imports #-} - -module Week03.IsData where - -import Control.Monad hiding (fmap) -import Data.Map as Map -import Data.Text (Text) -import Data.Void (Void) -import Plutus.Contract -import qualified PlutusTx -import PlutusTx.Prelude hiding (Semigroup(..), unless) -import Ledger hiding (singleton) -import Ledger.Constraints as Constraints -import qualified Ledger.Typed.Scripts as Scripts -import Ledger.Ada as Ada -import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage) -import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) -import Playground.Types (KnownCurrency (..)) -import Prelude (IO, Semigroup (..), Show, String) -import Text.Printf (printf) - -newtype MySillyRedeemer = MySillyRedeemer Integer - deriving Show - -PlutusTx.unstableMakeIsData ''MySillyRedeemer - -{-# INLINABLE mkValidator #-} -mkValidator :: () -> MySillyRedeemer -> ScriptContext -> Bool -mkValidator () (MySillyRedeemer r) _ = traceIfFalse "wrong redeemer" $ r == 42 - -data Typed -instance Scripts.ValidatorTypes Typed where - type instance DatumType Typed = () - type instance RedeemerType Typed = MySillyRedeemer - -typedValidator :: Scripts.TypedValidator Typed -typedValidator = Scripts.mkTypedValidator @Typed - $$(PlutusTx.compile [|| mkValidator ||]) - $$(PlutusTx.compile [|| wrap ||]) - where - wrap = Scripts.wrapValidator @() @MySillyRedeemer - -validator :: Validator -validator = Scripts.validatorScript typedValidator - -scrAddress :: Ledger.Address -scrAddress = scriptAddress validator - -type GiftSchema = - Endpoint "give" Integer - .\/ Endpoint "grab" Integer - -give :: AsContractError e => Integer -> Contract w s e () -give amount = do - let tx = mustPayToTheScript () $ Ada.lovelaceValueOf amount - ledgerTx <- submitTxConstraints typedValidator tx - void $ awaitTxConfirmed $ txId ledgerTx - logInfo @String $ printf "made a gift of %d lovelace" amount - -grab :: forall w s e. AsContractError e => Integer -> Contract w s e () -grab r = do - utxos <- utxoAt scrAddress - let orefs = fst <$> Map.toList utxos - lookups = Constraints.unspentOutputs utxos <> - Constraints.otherScript validator - tx :: TxConstraints Void Void - tx = mconcat [mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toData $ MySillyRedeemer r | oref <- orefs] - ledgerTx <- submitTxConstraintsWith @Void lookups tx - void $ awaitTxConfirmed $ txId ledgerTx - logInfo @String $ "collected gifts" - -endpoints :: Contract () GiftSchema Text () -endpoints = (give' `select` grab') >> endpoints - where - give' = endpoint @"give" >>= give - grab' = endpoint @"grab" >>= grab - -mkSchemaDefinitions ''GiftSchema - -mkKnownCurrencies [] diff --git a/code/week03/src/Week03/Parameterized.hs b/code/week03/src/Week03/Parameterized.hs index 43839c1..2c75e9a 100644 --- a/code/week03/src/Week03/Parameterized.hs +++ b/code/week03/src/Week03/Parameterized.hs @@ -11,6 +11,8 @@ {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeOperators #-} +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + module Week03.Parameterized where import Control.Monad hiding (fmap) @@ -20,6 +22,7 @@ import Data.Text (Text) import Data.Void (Void) import GHC.Generics (Generic) import Plutus.Contract +import PlutusTx (Data (..)) import qualified PlutusTx import PlutusTx.Prelude hiding (Semigroup(..), unless) import Ledger hiding (singleton) @@ -32,45 +35,44 @@ import Playground.Types (KnownCurrency (..)) import Prelude (IO, Semigroup (..), Show (..), String) import Text.Printf (printf) -{-# OPTIONS_GHC -fno-warn-unused-imports #-} - data VestingParam = VestingParam { beneficiary :: PubKeyHash , deadline :: POSIXTime } deriving Show -PlutusTx.unstableMakeIsData ''VestingParam PlutusTx.makeLift ''VestingParam {-# INLINABLE mkValidator #-} mkValidator :: VestingParam -> () -> () -> ScriptContext -> Bool -mkValidator p () () ctx = - traceIfFalse "beneficiary's signature missing" checkSig && - traceIfFalse "deadline not reached" checkDeadline +mkValidator p () () ctx = traceIfFalse "beneficiary's signature missing" signedByBeneficiary && + traceIfFalse "deadline not reached" deadlineReached where info :: TxInfo info = scriptContextTxInfo ctx - checkSig :: Bool - checkSig = beneficiary p `elem` txInfoSignatories info + signedByBeneficiary :: Bool + signedByBeneficiary = txSignedBy info $ beneficiary p - checkDeadline :: Bool - checkDeadline = from (deadline p) `contains` txInfoValidRange info + deadlineReached :: Bool + deadlineReached = contains (from $ deadline p) $ txInfoValidRange info data Vesting instance Scripts.ValidatorTypes Vesting where type instance DatumType Vesting = () type instance RedeemerType Vesting = () -inst :: VestingParam -> Scripts.TypedValidator Vesting -inst p = Scripts.mkTypedValidator @Vesting +typedValidator :: VestingParam -> Scripts.TypedValidator Vesting +typedValidator p = Scripts.mkTypedValidator @Vesting ($$(PlutusTx.compile [|| mkValidator ||]) `PlutusTx.applyCode` PlutusTx.liftCode p) $$(PlutusTx.compile [|| wrap ||]) where wrap = Scripts.wrapValidator @() @() validator :: VestingParam -> Validator -validator = Scripts.validatorScript . inst +validator = Scripts.validatorScript . typedValidator + +valHash :: VestingParam -> Ledger.ValidatorHash +valHash = Scripts.validatorHash . typedValidator scrAddress :: VestingParam -> Ledger.Address scrAddress = scriptAddress . validator @@ -92,7 +94,7 @@ give gp = do , deadline = gpDeadline gp } tx = mustPayToTheScript () $ Ada.lovelaceValueOf $ gpAmount gp - ledgerTx <- submitTxConstraints (inst p) tx + ledgerTx <- submitTxConstraints (typedValidator p) tx void $ awaitTxConfirmed $ txId ledgerTx logInfo @String $ printf "made a gift of %d lovelace to %s with deadline %s" (gpAmount gp) diff --git a/code/week03/src/Week03/Vesting.hs b/code/week03/src/Week03/Vesting.hs index bc08e43..501a618 100644 --- a/code/week03/src/Week03/Vesting.hs +++ b/code/week03/src/Week03/Vesting.hs @@ -21,6 +21,7 @@ import Data.Text (Text) import Data.Void (Void) import GHC.Generics (Generic) import Plutus.Contract +import PlutusTx (Data (..)) import qualified PlutusTx import PlutusTx.Prelude hiding (Semigroup(..), unless) import Ledger hiding (singleton) @@ -42,18 +43,17 @@ PlutusTx.unstableMakeIsData ''VestingDatum {-# INLINABLE mkValidator #-} mkValidator :: VestingDatum -> () -> ScriptContext -> Bool -mkValidator dat () ctx = - traceIfFalse "beneficiary's signature missing" checkSig && - traceIfFalse "deadline not reached" checkDeadline +mkValidator dat () ctx = traceIfFalse "beneficiary's signature missing" signedByBeneficiary && + traceIfFalse "deadline not reached" deadlineReached where info :: TxInfo info = scriptContextTxInfo ctx - checkSig :: Bool - checkSig = beneficiary dat `elem` txInfoSignatories info + signedByBeneficiary :: Bool + signedByBeneficiary = txSignedBy info $ beneficiary dat - checkDeadline :: Bool - checkDeadline = from (deadline dat) `contains` txInfoValidRange info + deadlineReached :: Bool + deadlineReached = contains (from $ deadline dat) $ txInfoValidRange info data Vesting instance Scripts.ValidatorTypes Vesting where @@ -70,6 +70,9 @@ typedValidator = Scripts.mkTypedValidator @Vesting validator :: Validator validator = Scripts.validatorScript typedValidator +valHash :: Ledger.ValidatorHash +valHash = Scripts.validatorHash typedValidator + scrAddress :: Ledger.Address scrAddress = scriptAddress validator From 28bf438c671b122e02c10c35a8d0b7f4f25cc477 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Wed, 14 Jul 2021 17:38:09 +0200 Subject: [PATCH 3/4] bumped Plutus version --- code/week03/cabal.project | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/code/week03/cabal.project b/code/week03/cabal.project index 41d6dbc..da5870c 100644 --- a/code/week03/cabal.project +++ b/code/week03/cabal.project @@ -1,4 +1,4 @@ -index-state: 2021-06-10T00:00:00Z +index-state: 2021-07-07T00:00:00Z packages: ./. @@ -25,7 +25,7 @@ source-repository-package prettyprinter-configurable quickcheck-dynamic word-array - tag: 08260fab8e1e695b288637c32a2248cdd7d264d4 + tag: 219992289c6615e197069d022735cb4059d43229 -- The following sections are copied from the 'plutus' repository cabal.project at the revision -- given above. @@ -112,8 +112,9 @@ source-repository-package source-repository-package type: git location: https://github.com/input-output-hk/ouroboros-network - tag: e50613562d6d4a0f933741fcf590b0f69a1eda67 + tag: e338f2cf8e1078fbda9555dd2b169c6737ef6774 subdir: + monoidal-synchronisation typed-protocols typed-protocols-examples ouroboros-network @@ -124,7 +125,7 @@ source-repository-package ouroboros-consensus-cardano ouroboros-consensus-shelley io-sim - io-sim-classes + io-classes network-mux source-repository-package @@ -144,7 +145,7 @@ source-repository-package source-repository-package type: git location: https://github.com/input-output-hk/cardano-ledger-specs - tag: a3ef848542961079b7cd53d599e5385198a3035c + tag: b8f1ebb46a91f1c634e616feb89ae34de5937e17 subdir: byron/chain/executable-spec byron/crypto @@ -167,9 +168,8 @@ source-repository-package source-repository-package type: git location: https://github.com/input-output-hk/cardano-node.git - tag: b3cabae6b3bf30a0b1b4e78bc4b67282dabad0a6 + tag: f3ef4ed72894499160f2330b91572a159005c148 subdir: - cardano-api/test cardano-api cardano-node cardano-cli From 79168906a294d2e6c0adbd6b123f0b77e39dd9a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Wed, 14 Jul 2021 21:06:45 +0200 Subject: [PATCH 4/4] updated README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index edaec0e..13b8e6c 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,17 @@ - Low-level, untyped on-chain validation scripts. - High-level, typed on-chain validation scripts. +- [Lecture #3](https://youtu.be/6_rfCCY9_gY) + + - Script contexts. + - Time handling. + - Parameterized contracts. + ## Code Examples - Lecture #1: [English Auction](code/week01) - Lecture #2: [Simple validation](code/week02) +- Lecture #2: [Script Context & Parameterized Contracts](code/week03) ## Exercises @@ -44,6 +51,11 @@ - Fix and complete the code in the [Homework1](code/week02/src/Week02/Homework1.hs) module. - Fix and complete the code in the [Homework2](code/week02/src/Week02/Homework2.hs) module. +- Week #3 + + - Fix and complete the code in the [Homework1](code/week03/src/Week03/Homework1.hs) module. + - Fix and complete the code in the [Homework2](code/week03/src/Week03/Homework2.hs) module. + ## Some Plutus Modules - [`Language.Marlowe.Semantics`](https://github.com/input-output-hk/plutus/blob/master/marlowe/src/Language/Marlowe/Semantics.hs), contains Marlowe types and semantics. @@ -51,6 +63,7 @@ - [`Plutus.Contract.Test`](https://github.com/input-output-hk/plutus/blob/master/plutus-contract/src/Plutus/Contract/Test.hs), provides various ways to write tests for Plutus contracts. - [`Plutus.Contract.Test.ContractModel`](https://github.com/input-output-hk/plutus/blob/master/plutus-contract/src/Plutus/Contract/Test/ContractModel.hs), support for property based testing of Plutus contracts. - [`Plutus.Contracts.Uniswap`](https://github.com/input-output-hk/plutus/blob/master/plutus-use-cases/src/Plutus/Contracts/Uniswap.hs), an implementation of Uniswap in Plutus. +- [`Plutus.Ledger.TimeSlot`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger/src/Ledger/TimeSlot.hs), conversions between `Slot` and `POSIXTime`. - [`Plutus.PAB.Webserver.API`](https://github.com/input-output-hk/plutus/blob/master/plutus-pab/src/Plutus/PAB/Webserver/API.hs), contains the HTTP-interface provided by the PAB. - [`Plutus.Trace.Emulator`](https://github.com/input-output-hk/plutus/blob/master/plutus-contract/src/Plutus/Trace/Emulator.hs), contains types and functions related to traces. - [`Plutus.V1.Ledger.Ada`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger-api/src/Plutus/V1/Ledger/Ada.hs), contains support for the Ada currency.