diff --git a/README.md b/README.md index bee5176..52a2c7d 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,18 @@ - Time handling. - Parameterized contracts. +- [Lecture #4](https://youtu.be/g4lvA14I-Jg) + + - Monads. + - The `EmulatorTrace`-monad. + - The `Contract`-monad. + ## Code Examples - Lecture #1: [English Auction](code/week01) - Lecture #2: [Simple validation](code/week02) - Lecture #3: [Script Context & Parameterized Contracts](code/week03) +- Lecture #4: [Monad, Traces & Contracts](code/week04) ## Exercises @@ -62,6 +69,11 @@ - 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. +- Week #4 + + - Implement function `payTrace` in the [Homework](code/week04/src/Week04/Homework.hs) module. + - Handle exceptions thrown by `submitTx` in function `payContract` in the same 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. diff --git a/code/week04/.devcontainer/devcontainer.json b/code/week04/.devcontainer/devcontainer.json new file mode 100644 index 0000000..51f7dce --- /dev/null +++ b/code/week04/.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/week04/.gitignore b/code/week04/.gitignore new file mode 100644 index 0000000..c33954f --- /dev/null +++ b/code/week04/.gitignore @@ -0,0 +1 @@ +dist-newstyle/ diff --git a/code/week04/LICENSE b/code/week04/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/code/week04/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/week04/app/hello.hs b/code/week04/app/hello.hs new file mode 100644 index 0000000..1ee195a --- /dev/null +++ b/code/week04/app/hello.hs @@ -0,0 +1,24 @@ +-- public static int foo() { +-- ... +-- } +-- +-- ... +-- +-- ... foo() ... foo() + +-- foo :: Int +-- foo = ... + +-- let x = foo in ... x ... x ... +-- ... foo ... foo ... + +-- foo :: IO Int +-- foo = ... + +main :: IO () +main = bar -- putStrLn "Hello, world!" + +bar :: IO () +bar = getLine >>= \s -> + getLine >>= \t -> + putStrLn (s ++ t) diff --git a/code/week04/cabal.project b/code/week04/cabal.project new file mode 100644 index 0000000..3c020b7 --- /dev/null +++ b/code/week04/cabal.project @@ -0,0 +1,193 @@ +index-state: 2021-07-07T00: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: 2fbb7abb22138a434bb6c4f663a81e9b9dc51e98 + +-- 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: e338f2cf8e1078fbda9555dd2b169c6737ef6774 + subdir: + monoidal-synchronisation + 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-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: ad951f017b5da37a622fb91b2ee2954d5eba201d + 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: f3ef4ed72894499160f2330b91572a159005c148 + subdir: + 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/week04/hie.yaml b/code/week04/hie.yaml new file mode 100644 index 0000000..6a400ef --- /dev/null +++ b/code/week04/hie.yaml @@ -0,0 +1,6 @@ +cradle: + cabal: + - path: "./src" + component: "lib:plutus-pioneer-program-week04" + - path: "./app/hello.hs" + component: "exe:hello" diff --git a/code/week04/plutus-pioneer-program-week04.cabal b/code/week04/plutus-pioneer-program-week04.cabal new file mode 100644 index 0000000..d684ebb --- /dev/null +++ b/code/week04/plutus-pioneer-program-week04.cabal @@ -0,0 +1,42 @@ +Cabal-Version: 2.4 +Name: plutus-pioneer-program-week04 +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: Week04.Contract + , Week04.Either + , Week04.Homework + , Week04.Maybe + , Week04.Monad + , Week04.Solution + , Week04.Trace + , Week04.Writer + other-modules: Week04.Vesting + build-depends: aeson + , base ^>=4.14.1.0 + , containers + , data-default + , freer-extras + , 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 + +executable hello + hs-source-dirs: app + main-is: hello.hs + build-depends: base ^>=4.14.1.0 + default-language: Haskell2010 + ghc-options: -Wall -O2 diff --git a/code/week04/src/Week04/Contract.hs b/code/week04/src/Week04/Contract.hs new file mode 100644 index 0000000..a729356 --- /dev/null +++ b/code/week04/src/Week04/Contract.hs @@ -0,0 +1,84 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE TypeOperators #-} + +module Week04.Contract where + +import Control.Monad.Freer.Extras as Extras +import Data.Functor (void) +import Data.Text (Text, unpack) +import Data.Void (Void) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import Wallet.Emulator.Wallet + +-- Contract w s e a +-- EmulatorTrace a + +myContract1 :: Contract () Empty Text () +myContract1 = do + void $ Contract.throwError "BOOM!" + Contract.logInfo @String "hello from the contract" + +myTrace1 :: EmulatorTrace () +myTrace1 = void $ activateContractWallet (Wallet 1) myContract1 + +test1 :: IO () +test1 = runEmulatorTraceIO myTrace1 + +myContract2 :: Contract () Empty Void () +myContract2 = Contract.handleError + (\err -> Contract.logError $ "caught: " ++ unpack err) + myContract1 + +myTrace2 :: EmulatorTrace () +myTrace2 = void $ activateContractWallet (Wallet 1) myContract2 + +test2 :: IO () +test2 = runEmulatorTraceIO myTrace2 + +type MySchema = Endpoint "foo" Int .\/ Endpoint "bar" String + +myContract3 :: Contract () MySchema Text () +myContract3 = do + n <- endpoint @"foo" + Contract.logInfo n + s <- endpoint @"bar" + Contract.logInfo s + +myTrace3 :: EmulatorTrace () +myTrace3 = do + h <- activateContractWallet (Wallet 1) myContract3 + callEndpoint @"foo" h 42 + callEndpoint @"bar" h "Haskell" + +test3 :: IO () +test3 = runEmulatorTraceIO myTrace3 + +myContract4 :: Contract [Int] Empty Text () +myContract4 = do + void $ Contract.waitNSlots 10 + tell [1] + void $ Contract.waitNSlots 10 + tell [2] + void $ Contract.waitNSlots 10 + +myTrace4 :: EmulatorTrace () +myTrace4 = do + h <- activateContractWallet (Wallet 1) myContract4 + + void $ Emulator.waitNSlots 5 + xs <- observableState h + Extras.logInfo $ show xs + + void $ Emulator.waitNSlots 10 + ys <- observableState h + Extras.logInfo $ show ys + + void $ Emulator.waitNSlots 10 + zs <- observableState h + Extras.logInfo $ show zs + +test4 :: IO () +test4 = runEmulatorTraceIO myTrace4 diff --git a/code/week04/src/Week04/Either.hs b/code/week04/src/Week04/Either.hs new file mode 100644 index 0000000..39d7b7a --- /dev/null +++ b/code/week04/src/Week04/Either.hs @@ -0,0 +1,31 @@ +module Week04.Either where + +import Text.Read (readMaybe) +import Week04.Monad + +readEither :: Read a => String -> Either String a +readEither s = case readMaybe s of + Nothing -> Left $ "can't parse: " ++ s + Just a -> Right a + +foo :: String -> String -> String -> Either String Int +foo x y z = case readEither x of + Left err -> Left err + Right k -> case readEither y of + Left err -> Left err + Right l -> case readEither z of + Left err -> Left err + Right m -> Right (k + l + m) + +bindEither :: Either String a -> (a -> Either String b) -> Either String b +bindEither (Left err) _ = Left err +bindEither (Right x) f = f x + +foo' :: String -> String -> String -> Either String Int +foo' x y z = readEither x `bindEither` \k -> + readEither y `bindEither` \l -> + readEither z `bindEither` \m -> + Right (k + l + m) + +foo'' :: String -> String -> String -> Either String Int +foo'' x y z = threeInts (readEither x) (readEither y) (readEither z) diff --git a/code/week04/src/Week04/Homework.hs b/code/week04/src/Week04/Homework.hs new file mode 100644 index 0000000..b02a295 --- /dev/null +++ b/code/week04/src/Week04/Homework.hs @@ -0,0 +1,44 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeOperators #-} + +module Week04.Homework where + +import Data.Aeson (FromJSON, ToJSON) +import Data.Functor (void) +import Data.Text (Text) +import GHC.Generics (Generic) +import Ledger +import Ledger.Ada as Ada +import Ledger.Constraints as Constraints +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator + +data PayParams = PayParams + { ppRecipient :: PubKeyHash + , ppLovelace :: Integer + } deriving (Show, Generic, FromJSON, ToJSON) + +type PaySchema = Endpoint "pay" PayParams + +payContract :: Contract () PaySchema Text () +payContract = do + pp <- endpoint @"pay" + let tx = mustPayToPubKey (ppRecipient pp) $ lovelaceValueOf $ ppLovelace pp + void $ submitTx tx + payContract + +-- A trace that invokes the pay endpoint of payContract on Wallet 1 twice, each time with Wallet 2 as +-- recipient, but with amounts given by the two arguments. There should be a delay of one slot +-- after each endpoint call. +payTrace :: Integer -> Integer -> EmulatorTrace () +payTrace _ _ = undefined -- IMPLEMENT ME! + +payTest1 :: IO () +payTest1 = runEmulatorTraceIO $ payTrace 1000000 2000000 + +payTest2 :: IO () +payTest2 = runEmulatorTraceIO $ payTrace 1000000000 2000000 diff --git a/code/week04/src/Week04/Maybe.hs b/code/week04/src/Week04/Maybe.hs new file mode 100644 index 0000000..f7e9ec5 --- /dev/null +++ b/code/week04/src/Week04/Maybe.hs @@ -0,0 +1,26 @@ +module Week04.Maybe where + +import Text.Read (readMaybe) +import Week04.Monad + +foo :: String -> String -> String -> Maybe Int +foo x y z = case readMaybe x of + Nothing -> Nothing + Just k -> case readMaybe y of + Nothing -> Nothing + Just l -> case readMaybe z of + Nothing -> Nothing + Just m -> Just (k + l + m) + +bindMaybe :: Maybe a -> (a -> Maybe b) -> Maybe b +bindMaybe Nothing _ = Nothing +bindMaybe (Just x) f = f x + +foo' :: String -> String -> String -> Maybe Int +foo' x y z = readMaybe x `bindMaybe` \k -> + readMaybe y `bindMaybe` \l -> + readMaybe z `bindMaybe` \m -> + Just (k + l + m) + +foo'' :: String -> String -> String -> Maybe Int +foo'' x y z = threeInts (readMaybe x) (readMaybe y) (readMaybe z) diff --git a/code/week04/src/Week04/Monad.hs b/code/week04/src/Week04/Monad.hs new file mode 100644 index 0000000..2a54dba --- /dev/null +++ b/code/week04/src/Week04/Monad.hs @@ -0,0 +1,26 @@ +module Week04.Monad where + +-- (>>=) :: IO a -> (a -> IO b) -> IO b +-- bindMaybe :: Maybe a -> (a -> Maybe b) -> Maybe b +-- bindEither :: Either String a -> (a -> Either String b) -> Either String b +-- bindWriter :: Writer a -> (a -> Writer b) -> Writer b +-- +-- return :: a -> IO a +-- Just :: a -> Maybe a +-- Right :: a -> Either String a +-- (\a -> Writer a []) :: a -> Writer a + +threeInts :: Monad m => m Int -> m Int -> m Int -> m Int +threeInts mx my mz = + mx >>= \k -> + my >>= \l -> + mz >>= \m -> + let s = k + l + m in return s + +threeInts' :: Monad m => m Int -> m Int -> m Int -> m Int +threeInts' mx my mz = do + k <- mx + l <- my + m <- mz + let s = k + l + m + return s diff --git a/code/week04/src/Week04/Solution.hs b/code/week04/src/Week04/Solution.hs new file mode 100644 index 0000000..7ba6f0d --- /dev/null +++ b/code/week04/src/Week04/Solution.hs @@ -0,0 +1,54 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeOperators #-} + +module Week04.Solution where + +import Data.Aeson (FromJSON, ToJSON) +import Data.Functor (void) +import Data.Text (Text, unpack) +import GHC.Generics (Generic) +import Ledger +import Ledger.Ada as Ada +import Ledger.Constraints as Constraints +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import Wallet.Emulator.Wallet + +data PayParams = PayParams + { ppRecipient :: PubKeyHash + , ppLovelace :: Integer + } deriving (Show, Generic, FromJSON, ToJSON) + +type PaySchema = Endpoint "pay" PayParams + +payContract :: Contract () PaySchema Text () +payContract = do + pp <- endpoint @"pay" + let tx = mustPayToPubKey (ppRecipient pp) $ lovelaceValueOf $ ppLovelace pp + handleError (\err -> Contract.logInfo $ "caught error: " ++ unpack err) $ void $ submitTx tx + payContract + +payTrace :: Integer -> Integer -> EmulatorTrace () +payTrace x y = do + h <- activateContractWallet (Wallet 1) payContract + let pkh = pubKeyHash $ walletPubKey $ Wallet 2 + callEndpoint @"pay" h $ PayParams + { ppRecipient = pkh + , ppLovelace = x + } + void $ Emulator.waitNSlots 1 + callEndpoint @"pay" h $ PayParams + { ppRecipient = pkh + , ppLovelace = y + } + void $ Emulator.waitNSlots 1 + +payTest1 :: IO () +payTest1 = runEmulatorTraceIO $ payTrace 1000000 2000000 + +payTest2 :: IO () +payTest2 = runEmulatorTraceIO $ payTrace 1000000000 2000000 diff --git a/code/week04/src/Week04/Trace.hs b/code/week04/src/Week04/Trace.hs new file mode 100644 index 0000000..f4442ac --- /dev/null +++ b/code/week04/src/Week04/Trace.hs @@ -0,0 +1,34 @@ +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE DataKinds #-} + +module Week04.Trace where + +import Control.Monad.Freer.Extras as Extras +import Data.Default (Default (..)) +import Data.Functor (void) +import Ledger +import Ledger.TimeSlot +import Plutus.Trace.Emulator as Emulator +import Wallet.Emulator.Wallet + +import Week04.Vesting + +-- Contract w s e a +-- EmulatorTrace a + +test :: IO () +test = runEmulatorTraceIO myTrace + +myTrace :: EmulatorTrace () +myTrace = do + h1 <- activateContractWallet (Wallet 1) endpoints + h2 <- activateContractWallet (Wallet 2) endpoints + callEndpoint @"give" h1 $ GiveParams + { gpBeneficiary = pubKeyHash $ walletPubKey $ Wallet 2 + , gpDeadline = slotToBeginPOSIXTime def 20 + , gpAmount = 10000000 + } + void $ waitUntilSlot 20 + callEndpoint @"grab" h2 () + s <- waitNSlots 1 + Extras.logInfo $ "reached " ++ show s diff --git a/code/week04/src/Week04/Vesting.hs b/code/week04/src/Week04/Vesting.hs new file mode 100644 index 0000000..d32af4d --- /dev/null +++ b/code/week04/src/Week04/Vesting.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 Week04.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 PlutusTx (Data (..)) +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" signedByBeneficiary && + traceIfFalse "deadline not reached" deadlineReached + where + info :: TxInfo + info = scriptContextTxInfo ctx + + signedByBeneficiary :: Bool + signedByBeneficiary = txSignedBy info $ beneficiary dat + + deadlineReached :: Bool + deadlineReached = contains (from $ deadline dat) $ 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 + +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 + 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.toBuiltinData () | 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.fromBuiltinData 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 [] diff --git a/code/week04/src/Week04/Writer.hs b/code/week04/src/Week04/Writer.hs new file mode 100644 index 0000000..ba0e0c5 --- /dev/null +++ b/code/week04/src/Week04/Writer.hs @@ -0,0 +1,53 @@ +module Week04.Writer where + +import Control.Monad +import Week04.Monad + +data Writer a = Writer a [String] + deriving Show + +number :: Int -> Writer Int +number n = Writer n $ ["number: " ++ show n] + +tell :: [String] -> Writer () +tell = Writer () + +foo :: Writer Int -> Writer Int -> Writer Int -> Writer Int +foo (Writer k xs) (Writer l ys) (Writer m zs) = + let + s = k + l + m + Writer _ us = tell ["sum: " ++ show s] + in + Writer s $ xs ++ ys ++ zs ++ us + +bindWriter :: Writer a -> (a -> Writer b) -> Writer b +bindWriter (Writer a xs) f = + let + Writer b ys = f a + in + Writer b $ xs ++ ys + +foo' :: Writer Int -> Writer Int -> Writer Int -> Writer Int +foo' x y z = x `bindWriter` \k -> + y `bindWriter` \l -> + z `bindWriter` \m -> + let s = k + l + m + in tell ["sum: " ++ show s] `bindWriter` \_ -> + Writer s [] + +foo'' :: Writer Int -> Writer Int -> Writer Int -> Writer Int +foo'' x y z = do + s <- threeInts x y z + tell ["sum: " ++ show s] + return s + +instance Functor Writer where + fmap = liftM + +instance Applicative Writer where + pure = return + (<*>) = ap + +instance Monad Writer where + return a = Writer a [] + (>>=) = bindWriter